RoutesService

Type
Class
Namespace
Craft
Inherits
Craft\RoutesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Class RoutesService

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$behaviors (opens new window) array (opens new window) – The behaviors that should be attached to this component.

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
deleteRouteById() Deletes a route by its ID.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) 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() (opens new window) Returns the list of attached event handlers for an event.
getIsInitialized() (opens new window) Checks if this application component has been initialized.
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
init() (opens new window) Initializes the application component.
isInitialized() Checks if this application component has been initialized yet, or not.
raiseEvent() (opens new window) Raises an event.
saveRoute() Saves a new or existing route.
updateRouteOrder() Updates the route order.

# deleteRouteById()

Deletes a route by its ID.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean deleteRouteById ( $routeId )

# getConfigFileRoutes()

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

View source (opens new window)

Returns

array (opens new window)

Signature

public array getConfigFileRoutes ( )

# getDbRoutes()

Returns the routes defined in the CP.

View source (opens new window)

Returns

array (opens new window)

Signature

public array getDbRoutes ( )

# saveRoute()

Saves a new or existing route.

View source (opens new window)

Arguments

Returns

Craft\RouteRecord

Throws

Signature

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

# updateRouteOrder()

Updates the route order.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null updateRouteOrder ( $routeIds )