RoutesService

Type
Class
Namespace
Craft
Inherits
Craft\RoutesService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class RoutesService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteRouteById()Deletes a route by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getConfigFileRoutes()Returns the routes defined in craft/config/routes.php
getDbRoutes()Returns the routes defined in the CP.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.
saveRoute()Saves a new or existing route.
updateRouteOrder()Updates the route order.

deleteRouteById()

Deletes a route by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteRouteById ( $routeId )

getConfigFileRoutes()

Returns the routes defined in craft/config/routes.php

View source

Returns

array

Signature

public array getConfigFileRoutes ( )

getDbRoutes()

Returns the routes defined in the CP.

View source

Returns

array

Signature

public array getDbRoutes ( )

saveRoute()

Saves a new or existing route.

View source

Arguments

  • $urlParts (array) – The URL as defined by the user. This is an array where each element is either a string or an array containing the name of a subpattern and the subpattern.
  • $template (string) – The template to route matching URLs to.
  • $routeId (integer, null) – The route ID, if editing an existing route.
  • $locale (string, null)

Returns

Craft\RouteRecord

Throws

Signature

public Craft\RouteRecord saveRoute ( $urlParts, $template, $routeId = null, $locale = null )

updateRouteOrder()

Updates the route order.

View source

Arguments

  • $routeIds (array) – An array of each of the route IDs, in their new order.

Returns

null

Signature

public null updateRouteOrder ( $routeIds )