HumHub Documentation (unofficial)

CompositeUrlRule extends BaseObject
in package
implements UrlRuleInterface

AbstractYes

CompositeUrlRule is the base class for URL rule classes that consist of multiple simpler rules.

Tags
author

Qiang Xue qiang.xue@gmail.com

since
2.0

Table of Contents

Interfaces

UrlRuleInterface
UrlRuleInterface is the interface that should be implemented by URL rule classes.

Properties

$createUrlStatus  : int|null
$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.
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.

Properties

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

$createStatus

protected int|null $createStatus

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

Tags
since
2.0.12

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

Methods

__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

Tags
throws
UnknownMethodException

when calling unknown method

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

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
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

Tags
see
https://www.php.net/manual/en/function.isset.php
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

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__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

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

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

Tags
see
canSetProperty()
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

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

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

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

Tags
see
createStatus
see
https://www.php.net/manual/en/language.operators.bitwise.php
since
2.0.12
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

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

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.

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

Tags
see
createUrl()
since
2.0.12
Return values
bool|string —

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results