0 follower

Abstract Class yii\web\CompositeUrlRule

All Classes | Properties | Methods
Inheritanceyii\web\CompositeUrlRule » yii\base\BaseObject
Implementsyii\base\Configurable, yii\web\UrlRuleInterface
Subclassesyii\rest\UrlRule, yii\web\GroupUrlRule
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/web/CompositeUrlRule.php

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

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$createUrlStatus null|integer Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status. This property is read-only. yii\web\CompositeUrlRule

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$createStatus integer|null Status of the URL creation after the last createUrl() call. yii\web\CompositeUrlRule
$rules yii\web\UrlRuleInterface[] The URL rules contained in this composite rule. yii\web\CompositeUrlRule

Public Methods

Hide inherited methods

MethodDescriptionDefined 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\web\CompositeUrlRule
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\web\CompositeUrlRule
parseRequest() Parses the given request and returns the corresponding route and parameters. yii\web\CompositeUrlRule

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createRules() Creates the URL rules that should be contained within this composite rule. yii\web\CompositeUrlRule
iterateRules() Iterates through specified rules and calls createUrl() for each of them. yii\web\CompositeUrlRule

Property Details

$createStatus protected property (available since version 2.0.12)

Status of the URL creation after the last createUrl() call.

protected integer|null $createStatus = null
$createUrlStatus public property

Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status. This property is read-only.

public null|integer $createUrlStatus = null
$rules protected property

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

protected yii\web\UrlRuleInterface[] $rules = []

Method Details

createRules() protected abstract method

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

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

The URL 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.
getCreateUrlStatus() public method (available since version 2.0.12)

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 null|integer getCreateUrlStatus ( )
return null|integer

Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status.
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 ( )
iterateRules() protected method (available since version 2.0.12)

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