UrlRule

API reference › yii › rest › UrlRule

class	`yii\rest\UrlRule`
Extends	`yii\web\CompositeUrlRule` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`, `yii\web\UrlRuleInterface`
Since	2.0
Source	`framework/rest/UrlRule.php`

UrlRule is provided to simplify the creation of URL rules for RESTful API support.

The simplest usage of UrlRule is to declare a rule like the following in the application configuration,

[
    'class' => 'yii\rest\UrlRule',
    'controller' => 'user',
]

The above code will create a whole set of URL rules supporting the following RESTful API endpoints:

'PUT,PATCH users/<id>' => 'user/update': update a user
'DELETE users/<id>' => 'user/delete': delete a user
'GET,HEAD users/<id>' => 'user/view': return the details/overview/options of a user
'POST users' => 'user/create': create a new user
'GET,HEAD users' => 'user/index': return a list/overview/options of users
'users/<id>' => 'user/options': process all unhandled verbs of a user
'users' => 'user/options': process all unhandled verbs of user collection

You may configure $only and/or $except to disable some of the above rules. You may configure $patterns to completely redefine your own list of rules. You may configure $controller with multiple controller IDs to generate rules for all these controllers. For example, the following code will disable the delete rule and generate rules for both user and post controllers:

[
    'class' => 'yii\rest\UrlRule',
    'controller' => ['user', 'post'],
    'except' => ['delete'],
]

The property $controller is required and should represent one or multiple controller IDs. Each controller ID should be prefixed with the module ID if the controller is within a module. The controller ID used in the pattern will be automatically pluralized (e.g. user becomes users as shown in the above examples).

For more details and usage information on UrlRule, see the guide article on rest routing.

Properties

Property	Type	Description	Defined by
`$controller`	`string\|array`	The controller ID (e.g. `user`, `post-comment`) that the rules in this composite rule are dealing with. Default: `null`.	`UrlRule`
`$createUrlStatus` read-only	`int\|null`	Status of the URL creation after the last `createUrl()` call. `null` if rule does not provide info about create status.	`yii\web\CompositeUrlRule`
`$except`	`array`	List of actions that should be excluded. Default: `[]`.	`UrlRule`
`$extraPatterns`	`array`	Patterns for supporting extra actions in addition to those listed in `$patterns`. Default: `[]`.	`UrlRule`
`$only`	`array`	List of acceptable actions. Default: `[]`.	`UrlRule`
`$patterns`	`array`	List of possible patterns and the corresponding actions for creating the URL rules. Default: `['PUT,PATCH {id}' => 'update', 'DELETE {id}' => 'delete', 'GET,HEAD {id}' => 'view', 'POST' => 'create', 'GET,HEAD' => 'index', '{id}' => 'options', '' => 'options']`.	`UrlRule`
`$pluralize`	`bool`	Whether to automatically pluralize the URL names for controllers. Default: `true`.	`UrlRule`
`$prefix`	`string\|null`	The common prefix string shared by all patterns. Default: `null`.	`UrlRule`
`$ruleConfig`	`array`	The default configuration for creating each URL rule contained by this rule. Default: `['class' => 'yii\web\UrlRule']`.	`UrlRule`
`$suffix`	`string`	The suffix that will be assigned to `UrlRule::$suffix` for every generated rule. Default: `null`.	`UrlRule`
`$tokens`	`array`	List of tokens that should be replaced for each pattern. Default: `['{id}' => '<id:\d[\d]*>']`.	`UrlRule`
`$createStatus` protected	`int\|null`	Status of the URL creation after the last `createUrl()` call. Default: `null`. Available since 2.0.12.	`yii\web\CompositeUrlRule`
`$rules` protected	`yii\web\UrlRuleInterface[]\|yii\web\UrlRuleInterface[][]\|array[]\|string[]`	The URL rules contained in this composite rule. Default: `[]`.	`yii\web\CompositeUrlRule`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`createUrl()`	Creates a URL according to the given route and parameters.	`UrlRule`
`getCreateUrlStatus()`	Returns status of the URL creation after the last `createUrl()` call.	`yii\web\CompositeUrlRule`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`UrlRule`
`parseRequest()`	Parses the given request and returns the corresponding route and parameters.	`UrlRule`
`createRule()` protected	Creates a URL rule using the given pattern and action.	`UrlRule`
`createRules()` protected	Creates the URL rules that should be contained within this composite rule.	`UrlRule`
`iterateRules()` protected	Iterates through specified rules and calls `createUrl()` for each of them.	`yii\web\CompositeUrlRule`

Property details

$controller

public string|array $controller = null

The controller ID (e.g. user, post-comment) that the rules in this composite rule are dealing with.

It should be prefixed with the module ID if the controller is within a module (e.g. admin/user).

By default, the controller ID will be pluralized automatically when it is put in the patterns of the generated rules. If you want to explicitly specify how the controller ID should appear in the patterns, you may use an array with the array key being as the controller ID in the pattern, and the array value the actual controller ID. For example, ['u' => 'user'].

You may also pass multiple controller IDs as an array. If this is the case, this composite rule will generate applicable URL rules for EVERY specified controller. For example, ['user', 'post'].

$except

public array $except = []

List of actions that should be excluded.

Any action found in this array will NOT have its URL rules created.

$extraPatterns

public array $extraPatterns = []

Patterns for supporting extra actions in addition to those listed in $patterns.

The keys are the patterns and the values are the corresponding action IDs. These extra patterns will take precedence over $patterns.

$only

public array $only = []

List of acceptable actions.

If not empty, only the actions within this array will have the corresponding URL rules created.

$patterns

public array $patterns = ['PUT,PATCH {id}' => 'update', 'DELETE {id}' => 'delete', 'GET,HEAD {id}' => 'view', 'POST' => 'create', 'GET,HEAD' => 'index', '{id}' => 'options', '' => 'options']

List of possible patterns and the corresponding actions for creating the URL rules.

The keys are the patterns and the values are the corresponding actions. The format of patterns is Verbs Pattern, where Verbs stands for a list of HTTP verbs separated by comma (without space). If Verbs is not specified, it means all verbs are allowed. Pattern is optional. It will be prefixed with $prefix/$controller/, and tokens in it will be replaced by $tokens.

$pluralize

public bool $pluralize = true

Whether to automatically pluralize the URL names for controllers.

If true, a controller ID will appear in plural form in URLs. For example, user controller will appear as users in URLs.

$tokens

public array $tokens = ['{id}' => '<id:\d[\d]*>']

List of tokens that should be replaced for each pattern.

The keys are the token names, and the values are the corresponding replacements.

Method details

createUrl()

public function createUrl(mixed $manager, mixed $route, mixed $params): string|bool

Creates a URL according to the given route and parameters.

Parameters

Parameter	Type	Description
`$manager`	`mixed`	The URL manager
`$route`	`mixed`	The route. It should not have slashes at the beginning or the end.
`$params`	`mixed`	The parameters

Returns

string|bool: The created URL, or false if this rule cannot be used for creating this URL.

init()

public function init(): mixed

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

Returns

mixed

parseRequest()

public function parseRequest(mixed $manager, mixed $request): array|bool

Parses the given request and returns the corresponding route and parameters.

Parameters

Parameter	Type	Description
`$manager`	`mixed`	The URL manager
`$request`	`mixed`	The request component

Returns

array|bool: The parsing result. The route and the parameters are returned as an array. If false, it means this rule cannot be used to parse this path info.

createRule()

protected function createRule(string $pattern, string $prefix, string $action): yii\web\UrlRuleInterface

Creates a URL rule using the given pattern and action.

Parameters

Parameter	Type	Description
`$pattern`	`string`
`$prefix`	`string`
`$action`	`string`

Returns

yii\web\UrlRuleInterface

createRules()

protected function createRules(): yii\web\UrlRuleInterface[]|yii\web\UrlRuleInterface[][]

Creates the URL rules that should be contained within this composite rule.

Returns

yii\web\UrlRuleInterface[]|yii\web\UrlRuleInterface[][]: The URL rules