Spec-Zone.ru › Yii 2.0

Абстрактный класс yii\web\CompositeUrlRule

Все классы | Свойства | Методы
Наследование yii\web\CompositeUrlRule » yii\base\Object
Реализует yii\base\Configurable, yii\web\UrlRuleInterface
Подклассы yii\rest\UrlRule, yii\web\GroupUrlRule
Доступна с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/web/CompositeUrlRule.php

CompositeUrlRule — базовый класс для классов правил URL, состоящих из нескольких более простых правил.

Публичные свойства

Свойство Тип Описание Определено в
$createUrlStatus null|целое число Статус создания URL после последнего вызова createUrl(). yii\web\CompositeUrlRule

Защищенные свойства

Свойство Тип Описание Определено в
$createStatus целое число|null Статус создания URL после последнего вызова createUrl(). yii\web\CompositeUrlRule
$rules yii\web\UrlRuleInterface[] Правила URL, содержащиеся в этом составном правиле. yii\web\CompositeUrlRule

Публичные методы

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
createUrl() Создаёт URL в соответствии с заданным маршрутом и параметрами. yii\web\CompositeUrlRule
getCreateUrlStatus() Возвращает статус создания URL после последнего вызова createUrl(). yii\web\CompositeUrlRule
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\web\CompositeUrlRule
parseRequest() Парсит заданный запрос и возвращает соответствующий маршрут и параметры. yii\web\CompositeUrlRule

Защищенные методы

Метод Описание Определено в
createRules() Создаёт правила URL, которые должны содержаться в этом составном правиле. yii\web\CompositeUrlRule
iterateRules() Итерируется по заданным правилам и вызывает createUrl() для каждого из них. yii\web\CompositeUrlRule

Подробное описание свойств

$createStatus защищенное свойство (доступно с версии 2.0.12)

Статус создания URL после последнего вызова createUrl().

protected integer|null $createStatus = null

$createUrlStatus публичное только для чтения свойство

Статус создания URL после последнего вызова createUrl(). null Если правило не предоставляет информацию о статусе создания.

public null|integer getCreateUrlStatus ( )

$rules защищенное свойство

Правила URL, содержащиеся в этом составном правиле. Это свойство устанавливается в init() возвращаемым значением createRules().

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

Подробное описание методов

createRules() protected abstract method

Создаёт правила URL, которые должны быть включены в это составное правило.

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

Правила URL

createUrl() public method

Создаёт URL в соответствии с заданным маршрутом и параметрами.

public string|boolean createUrl ( $manager, $route, $params )
$manager yii\web\UrlManager

Менеджер URL

$route string

Маршрут. Он не должен содержать слешей в начале или в конце.

$params array

Параметры

return string|boolean

Созданный URL или false, если это правило нельзя использовать для создания этого URL.

getCreateUrlStatus() public method (доступно с версии 2.0.12)

Возвращает состояние создания URL после последнего вызова createUrl().

Для нескольких правил состояния будут объединены с помощью побитового or оператора (например, UrlRule::CREATE_STATUS_PARSING_ONLY | UrlRule::CREATE_STATUS_PARAMS_MISMATCH).

См. также:

  • $createStatus
  • http://php.net/manual/en/language.operators.bitwise.php
public null|integer getCreateUrlStatus ( )
return null|integer

Состояние создания URL после последнего вызова createUrl(). null если правило не предоставляет информацию о статусе создания.

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

iterateRules() protected method (доступно с версии 2.0.12)

Итерируется по заданным правилам и вызывает createUrl() для каждого из них.

См. также createUrl().

protected boolean|string iterateRules ( $rules, $manager, $route, $params )
$rules yii\web\UrlRuleInterface[]

Правила для итерации.

$manager yii\web\UrlManager

Менеджер URL

$route string

Маршрут. Он не должен содержать слешей в начале или в конце.

$params array

Параметры

return boolean|string

Созданный URL или false если ни одно из указанных правил не может быть использовано для создания этого URL.

parseRequest() public method

Разбирает заданный запрос и возвращает соответствующий маршрут и параметры.

public array|boolean parseRequest ( $manager, $request )
$manager yii\web\UrlManager

Менеджер URL

$request yii\web\Request

Компонент запроса

return array|boolean

Результат разбора. Маршрут и параметры возвращаются в виде массива. Если false, это означает, что это правило не может быть использовано для разбора этой информации пути.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-compositeurlrule.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API