HumHub Documentation (unofficial)

GroupUrlRule extends CompositeUrlRule
in package

Application

GroupUrlRule represents a collection of URL rules sharing the same prefix in their patterns and routes.

GroupUrlRule is best used by a module which often uses module ID as the prefix for the URL rules. For example, the following code creates a rule for the admin module:

new GroupUrlRule([
    'prefix' => 'admin',
    'rules' => [
        'login' => 'user/login',
        'logout' => 'user/logout',
        'dashboard' => 'default/dashboard',
    ],
]);

// the above rule is equivalent to the following three rules:

[
    'admin/login' => 'admin/user/login',
    'admin/logout' => 'admin/user/logout',
    'admin/dashboard' => 'admin/default/dashboard',
]

The above example assumes the prefix for patterns and routes are the same. They can be made different by configuring [[prefix]] and [[routePrefix]] separately.

Using a GroupUrlRule is more efficient than directly declaring the individual rules it contains. This is because GroupUrlRule can quickly determine if it should process a URL parsing or creation request by simply checking if the prefix matches.

Properties

$createUrlStatus : int|null
$prefix : string
$routePrefix : string|null
$ruleConfig : array<string|int, mixed>
$rules : array<string|int, mixed>
$createStatus : int|null

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

$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.

$prefix


    public
        string
    $prefix

the prefix for the pattern part of every rule declared in [[rules]]. The prefix and the pattern will be separated with a slash.

$routePrefix


    public
        string|null
    $routePrefix

the prefix for the route part of every rule declared in [[rules]]. The prefix and the route will be separated with a slash. If this property is not set, it will take the value of [[prefix]].

$ruleConfig


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

the default configuration of URL rules. Individual rule configurations specified via [[rules]] will take precedence when the same property of the rule is configured.

$rules


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

the rules contained within this composite rule. Please refer to [[UrlManager::rules]] for the format of this property.

$createStatus


    protected
        int|null
    $createStatus

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

__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.

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.

GroupUrlRule extends CompositeUrlRule in package Application

Tags

Table of Contents

Properties

Methods

Properties

$createUrlStatus read-only

$prefix

$routePrefix

$ruleConfig

$rules

Tags

$createStatus

Tags

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

createRules()

Return values

iterateRules()

Parameters

Tags

Return values

GroupUrlRule extends CompositeUrlRule
in package

Application