Class yii\rest\UrlRule

All Classes | Properties | Methods
Inheritanceyii\rest\UrlRule » yii\web\CompositeUrlRule » yii\base\BaseObject
Implementsyii\base\Configurable, yii\web\UrlRuleInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/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.

Public Properties

Hide inherited 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. yii\rest\UrlRule
$createStatus integer|null Status of the URL creation after the last createUrl() call. yii\web\CompositeUrlRule
$createUrlStatus integer|null Status of the URL creation after the last createUrl() call. yii\web\CompositeUrlRule
$except array List of actions that should be excluded. yii\rest\UrlRule
$extraPatterns array Patterns for supporting extra actions in addition to those listed in $patterns. yii\rest\UrlRule
$only array List of acceptable actions. yii\rest\UrlRule
$patterns array List of possible patterns and the corresponding actions for creating the URL rules. yii\rest\UrlRule
$pluralize boolean Whether to automatically pluralize the URL names for controllers. yii\rest\UrlRule
$prefix string|null The common prefix string shared by all patterns. yii\rest\UrlRule
$ruleConfig array The default configuration for creating each URL rule contained by this rule. yii\rest\UrlRule
$rules yii\web\UrlRuleInterface[] The URL rules contained in this composite rule. yii\web\CompositeUrlRule
$suffix string The suffix that will be assigned to yii\web\UrlRule::$suffix for every generated rule. yii\rest\UrlRule
$tokens array List of tokens that should be replaced for each pattern. yii\rest\UrlRule

Protected Properties

Hide inherited properties

Property Type Description Defined By

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. 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() Returns the fully qualified name of this class. yii\base\BaseObject
createUrl() Creates a URL according to the given route and parameters. yii\rest\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. yii\rest\UrlRule
parseRequest() Parses the given request and returns the corresponding route and parameters. yii\rest\UrlRule

Protected Methods

Hide inherited methods

Method Description Defined By
createRule() Creates a URL rule using the given pattern and action. yii\rest\UrlRule
createRules() Creates the URL rules that should be contained within this composite rule. yii\rest\UrlRule
iterateRules() Iterates through specified rules and calls createUrl() for each of them. yii\web\CompositeUrlRule

Property Details

Hide inherited properties

$controller public property

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'].

public string|array $controller = null
$except public property

List of actions that should be excluded. Any action found in this array will NOT have its URL rules created.

See also $patterns.

public array $except = []
$extraPatterns public property

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.

public array $extraPatterns = []
$only public property

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

See also $patterns.

public array $only = []
$patterns public property

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.

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

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.

See also $controller.

public boolean $pluralize = true
$prefix public property

The common prefix string shared by all patterns.

public string|null $prefix = null
$ruleConfig public property

The default configuration for creating each URL rule contained by this rule.

public array $ruleConfig = [
    'class' => 'yii\web\UrlRule',
]
$suffix public property

The suffix that will be assigned to yii\web\UrlRule::$suffix for every generated rule.

public string $suffix = null
$tokens public property

List of tokens that should be replaced for each pattern. The keys are the token names, and the values are the corresponding replacements.

See also $patterns.

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

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name
$params array

Method parameters
return mixed

The method return value
throws yii\base\UnknownMethodException

when calling unknown method

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name
$value mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is read-only

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

                public static function className()
{
    return get_called_class();
}
createRule() protected method

Creates a URL rule using the given pattern and action.

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

                protected function createRule($pattern, $prefix, $action)
{
    $verbs = 'GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS';
    if (preg_match("/^((?:($verbs),)*($verbs))(?:\\s+(.*))?$/", $pattern, $matches)) {
        $verbs = explode(',', $matches[1]);
        $pattern = isset($matches[4]) ? $matches[4] : '';
    } else {
        $verbs = [];
    }
    $config = $this->ruleConfig;
    $config['verb'] = $verbs;
    $config['pattern'] = rtrim($prefix . '/' . strtr($pattern, $this->tokens), '/');
    $config['route'] = $action;
    $config['suffix'] = $this->suffix;
    return Yii::createObject($config);
}
createRules() protected method

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

protected yii\web\UrlRuleInterface[] createRules ( )
return yii\web\UrlRuleInterface[]

The URL rules

 

                protected function createRules()
{
    $only = array_flip($this->only);
    $except = array_flip($this->except);
    $patterns = $this->extraPatterns + $this->patterns;
    $rules = [];
    foreach ($this->controller as $urlName => $controller) {
        $prefix = trim($this->prefix . '/' . $urlName, '/');
        foreach ($patterns as $pattern => $action) {
            if (!isset($except[$action]) && (empty($only) || isset($only[$action]))) {
                $rules[$urlName][] = $this->createRule($pattern, $prefix, $controller . '/' . $action);
            }
        }
    }
    return $rules;
}
createUrl() public method

Creates a URL according to the given route and parameters.

public string|boolean createUrl ( $manager, $route, $params )
$manager yii\web\UrlManager

The URL manager
$route string

The route. It should not have slashes at the beginning or the end.
$params array

The parameters
return string|boolean

The created URL, or false if this rule cannot be used for creating this URL.

 

                public function createUrl($manager, $route, $params)
{
    $this->createStatus = WebUrlRule::CREATE_STATUS_SUCCESS;
    foreach ($this->controller as $urlName => $controller) {
        if (strpos($route, $controller) !== false) {
            /* @var $rules UrlRuleInterface[] */
            $rules = $this->rules[$urlName];
            $url = $this->iterateRules($rules, $manager, $route, $params);
            if ($url !== false) {
                return $url;
            }
        } else {
            $this->createStatus |= WebUrlRule::CREATE_STATUS_ROUTE_MISMATCH;
        }
    }
    if ($this->createStatus === WebUrlRule::CREATE_STATUS_SUCCESS) {
        // create status was not changed - there is no rules configured
        $this->createStatus = WebUrlRule::CREATE_STATUS_PARSING_ONLY;
    }
    return false;
}
getCreateUrlStatus() public method (available since version 2.0.12)

Defined in: yii\web\CompositeUrlRule::getCreateUrlStatus()

Returns status of the URL creation after the last createUrl() call.

For multiple rules statuses will be combined by bitwise or operator (e.g. UrlRule::CREATE_STATUS_PARSING_ONLY | UrlRule::CREATE_STATUS_PARAMS_MISMATCH).

See also:

public integer|null getCreateUrlStatus ( )
return integer|null

Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status.

 

                public function getCreateUrlStatus()
{
    return $this->createStatus;
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

Initializes the object.

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

public void init ( )

                public function init()
{
    if (empty($this->controller)) {
        throw new InvalidConfigException('"controller" must be set.');
    }
    $controllers = [];
    foreach ((array) $this->controller as $urlName => $controller) {
        if (is_int($urlName)) {
            $urlName = $this->pluralize ? Inflector::pluralize($controller) : $controller;
        }
        $controllers[$urlName] = $controller;
    }
    $this->controller = $controllers;
    $this->prefix = trim((string)$this->prefix, '/');
    parent::init();
}
iterateRules() protected method (available since version 2.0.12)

Defined in: yii\web\CompositeUrlRule::iterateRules()

Iterates through specified rules and calls createUrl() for each of them.

See also createUrl().

protected boolean|string iterateRules ( $rules, $manager, $route, $params )
$rules yii\web\UrlRuleInterface[]

Rules to iterate.
$manager yii\web\UrlManager

The URL manager
$route string

The route. It should not have slashes at the beginning or the end.
$params array

The parameters
return boolean|string

The created URL, or false if none of specified rules cannot be used for creating this URL.

 

                protected function iterateRules($rules, $manager, $route, $params)
{
    /* @var $rule UrlRule */
    foreach ($rules as $rule) {
        $url = $rule->createUrl($manager, $route, $params);
        if ($url !== false) {
            $this->createStatus = UrlRule::CREATE_STATUS_SUCCESS;
            return $url;
        }
        if (
            $this->createStatus === null
            || !method_exists($rule, 'getCreateUrlStatus')
            || $rule->getCreateUrlStatus() === null
        ) {
            $this->createStatus = null;
        } else {
            $this->createStatus |= $rule->getCreateUrlStatus();
        }
    }
    return false;
}
parseRequest() public method

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

public array|boolean parseRequest ( $manager, $request )
$manager yii\web\UrlManager

The URL manager
$request yii\web\Request

The request component
return array|boolean

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.

 

                public function parseRequest($manager, $request)
{
    $pathInfo = $request->getPathInfo();
    if (
        $this->prefix !== ''
        && strpos($this->prefix, '<') === false
        && strpos($pathInfo . '/', $this->prefix . '/') !== 0
    ) {
        return false;
    }
    foreach ($this->rules as $urlName => $rules) {
        if (strpos($pathInfo, $urlName) !== false) {
            foreach ($rules as $rule) {
                /* @var $rule WebUrlRule */
                $result = $rule->parseRequest($manager, $request);
                if (YII_DEBUG) {
                    Yii::debug([
                        'rule' => method_exists($rule, '__toString') ? $rule->__toString() : get_class($rule),
                        'match' => $result !== false,
                        'parent' => self::className(),
                    ], __METHOD__);
                }
                if ($result !== false) {
                    return $result;
                }
            }
        }
    }
    return false;
}