没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Abstract Class yii\web\CompositeUrlRule

继承yii\web\CompositeUrlRule » yii\base\BaseObject
实现yii\base\Configurable, yii\web\UrlRuleInterface
子类yii\rest\UrlRule, yii\web\GroupUrlRule
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/web/CompositeUrlRule.php

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

公共属性

隐藏继承的属性

属性类型描述被定义在
$createUrlStatus null|integer Status of the URL creation after the last createUrl() call. yii\web\CompositeUrlRule

受保护的属性

隐藏继承的属性

属性类型描述被定义在
$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

公共方法

隐藏继承的方法

方法描述被定义在
__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

受保护的方法

隐藏继承的方法

方法描述被定义在
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

属性详情

$createStatus 受保护 属性 (自版本 2.0.12 可用)

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

protected integer|null $createStatus null
$createUrlStatus 公共 只读 属性

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

$rules 受保护 属性

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

方法详情

createRules() 受保护 抽象 方法

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() 公共 方法

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() 公共 方法 (自版本 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).

参见:

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() 公共 方法

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() 受保护 方法 (自版本 2.0.12 可用)

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

参见 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() 公共 方法

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.