HumHub Documentation (unofficial)

UrlRule extends CompositeUrlRule
in package

Application

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

$controller : string|array<string|int, mixed>
$createUrlStatus : int|null
$except : array<string|int, mixed>
$extraPatterns : array<string|int, mixed>
$only : array<string|int, mixed>
$patterns : array<string|int, mixed>
$pluralize : bool
$prefix : string|null
$ruleConfig : array<string|int, mixed>
$suffix : string
$tokens : array<string|int, mixed>
$createStatus : int|null
$rules : array<string|int, UrlRuleInterface>

Methods

__call() : mixed: Calls the named method which is not a class method.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of an object property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets value of an object property.
__unset() : mixed: Sets an object property to null.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
createUrl() : string|bool: Creates a URL according to the given route and parameters.
getCreateUrlStatus() : int|null: Returns status of the URL creation after the last [[createUrl()]] call.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined.
init() : mixed: Initializes the object.
parseRequest() : array<string|int, mixed>|bool: Parses the given request and returns the corresponding route and parameters.
createRule() : UrlRuleInterface: Creates a URL rule using the given pattern and action.
createRules() : array<string|int, UrlRuleInterface>: Creates the URL rules that should be contained within this composite rule.
iterateRules() : bool|string: Iterates through specified rules and calls [[createUrl()]] for each of them.

$controller


    public
        string|array<string|int, mixed>
    $controller

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

$createUrlStatus read-only


    public
        int|null
    $createUrlStatus

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

$except


    public
        array<string|int, mixed>
    $except
     = []

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

$extraPatterns


    public
        array<string|int, mixed>
    $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<string|int, mixed>
    $only
     = []

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

$patterns


    public
        array<string|int, mixed>
    $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.

$prefix


    public
        string|null
    $prefix

the common prefix string shared by all patterns.

$ruleConfig


    public
        array<string|int, mixed>
    $ruleConfig
     = ['class' => 'yii\web\UrlRule']

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

$suffix


    public
        string
    $suffix

the suffix that will be assigned to [[\yii\web\UrlRule::suffix]] for every generated rule.

$tokens


    public
        array<string|int, mixed>
    $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.

$createStatus


    protected
        int|null
    $createStatus

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

$rules


    protected
        array<string|int, UrlRuleInterface>
    $rules
     = []

the URL rules contained in this composite rule. This property is set in [[init()]] by the return value of [[createRules()]].

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

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.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.


    public
                    __get(string $name) : mixed

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

Parameters

$name : string: the property name

Return values

mixed —

the property value

__isset()

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


    public
                    __isset(string $name) : bool

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.

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set (not null).

__set()

Sets value of an object property.


    public
                    __set(string $name, mixed $value) : mixed

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

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets an object property to null.


    public
                    __unset(string $name) : mixed

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.

Parameters

$name : string: the property name

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

createUrl()

Creates a URL according to the given route and parameters.


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

Parameters

$manager : mixed: the URL manager
$route : mixed: the route. It should not have slashes at the beginning or the end.
$params : mixed: the parameters

Return values

string|bool —

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

getCreateUrlStatus()

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


    public
                    getCreateUrlStatus() : int|null

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

Return values

int|null —

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

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name) : bool

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

Parameters

$name : string: the method name

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.


    public
                    hasProperty(string $name[, bool $checkVars = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

parseRequest()

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


    public
                    parseRequest(mixed $manager, mixed $request) : array<string|int, mixed>|bool

Parameters

$manager : mixed: the URL manager
$request : mixed: the request component

Return values

array<string|int, mixed>|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()

Creates a URL rule using the given pattern and action.


    protected
                    createRule(string $pattern, string $prefix, string $action) : UrlRuleInterface

Parameters

$pattern : string
$prefix : string
$action : string

Return values

UrlRuleInterface

createRules()

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


    protected
                    createRules() : array<string|int, UrlRuleInterface>

Return values

array<string|int, UrlRuleInterface> —

the URL rules

iterateRules()

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


    protected
                    iterateRules(array<string|int, UrlRuleInterface> $rules, UrlManager $manager, string $route, array<string|int, mixed> $params) : bool|string

Parameters

$rules : array<string|int, UrlRuleInterface>: rules to iterate.
$manager : UrlManager: the URL manager
$route : string: the route. It should not have slashes at the beginning or the end.
$params : array<string|int, mixed>: the parameters

Return values

bool|string —

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

UrlRule extends CompositeUrlRule in package Application

Tags

Table of Contents

Properties

Methods

Properties

$controller

$createUrlStatus read-only

$except

Tags

$extraPatterns

$only

Tags

$patterns

$pluralize

Tags

$prefix

$ruleConfig

$suffix

$tokens

Tags

$createStatus

Tags

$rules

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

createUrl()

Parameters

Return values

getCreateUrlStatus()

Tags

Return values

hasMethod()

Parameters

Return values

hasProperty()

Parameters

Tags

Return values

init()

parseRequest()

Parameters

Return values

UrlRule extends CompositeUrlRule
in package

Application