RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-rest-urlrule below:

UrlRule, yii\rest\UrlRule | API Documentation for Yii 2.0

Class yii\rest\UrlRule

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.

Property Details

Hide inherited properties

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

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

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

Source code

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

Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Source code

                public static function className()
{
    return get_called_class();
}

Creates a URL rule using the given pattern and action.

Source code

                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);
}

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

Source code

                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;
}

Creates a URL according to the given route and parameters.

Source code

                public function createUrl($manager, $route, $params)
{
    $this->createStatus = WebUrlRule::CREATE_STATUS_SUCCESS;
    foreach ($this->controller as $urlName => $controller) {
        if (strpos($route, $controller) !== false) {
            
            $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) {
        
        $this->createStatus = WebUrlRule::CREATE_STATUS_PARSING_ONLY;
    }
    return false;
}

Source code

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

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().

Source code

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

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);