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