Routes
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Routes » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Routes service.
An instance of the service is available via Craft::$app->routes.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| configFileRoutes | array (opens new window) |
| projectConfigRoutes | array (opens new window) |
# configFileRoutes
- Type
- array (opens new window)
- Default value
null- Access
- Read-only
View source (opens new window)
# projectConfigRoutes
- Type
- array (opens new window)
- Default value
null- Access
- Read-only
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| deleteRouteByUid() | 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. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getConfigFileRoutes() | Returns the routes defined in config/routes.php |
| getProjectConfigRoutes() | Returns the routes defined in the project config. |
| handleDeletedSite() | Handle a deleted site when it affects existing routes |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| saveRoute() | Saves a new or existing route. |
| trigger() (opens new window) | Triggers an event. |
| updateRouteOrder() | Updates the route order. |
# deleteRouteByUid()
- Since
- 3.1.0
Deletes a route by its ID.
View source (opens new window)
Arguments
$routeUid(string (opens new window))
Returns
# getConfigFileRoutes()
Returns the routes defined in config/routes.php
View source (opens new window)
Returns
# getProjectConfigRoutes()
Returns the routes defined in the project config.
View source (opens new window)
Returns
# handleDeletedSite()
Handle a deleted site when it affects existing routes
View source (opens new window)
Arguments
$event(craft\events\DeleteSiteEvent)
# saveRoute()
Saves a new or existing route.
View source (opens new window)
Arguments
$uriParts(array (opens new window)) – The URI 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 (opens new window)) – The template to route matching requests to$siteUid(string (opens new window), null (opens new window)) – The site UID the route should be limited to, if any$routeUid(string (opens new window), null (opens new window)) – The route UID, if editing an existing route
Returns
string (opens new window) – $routeUid The route UID.
# updateRouteOrder()
Updates the route order.
View source (opens new window)
Arguments
$routeUids(array (opens new window)) – An array of each of the route UIDs, in their new order.
# Events
# EVENT_AFTER_DELETE_ROUTE
The event that is triggered after a route is deleted.
# EVENT_AFTER_SAVE_ROUTE
The event that is triggered after a route is saved.
# EVENT_BEFORE_DELETE_ROUTE
The event that is triggered before a route is deleted.
# EVENT_BEFORE_SAVE_ROUTE
The event that is triggered before a route is saved.