Класс yii\web\UrlRule

UrlRule представляет собой правило, используемое yii\web\UrlManager для разбора и генерации URL-адресов.

Для определения собственной логики разбора и создания URL-адресов можно расширить этот класс и добавить его в yii\web\UrlManager::$rules, например так:

'rules' => [
    ['class' => 'MyUrlRule', 'pattern' => '...', 'route' => 'site/index', ...],
    // ...
]

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

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

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

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

Константы

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

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

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

protected integer|null $createStatus = null

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

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

public null|integer getCreateUrlStatus ( )

$defaults общедоступное свойство

Параметры GET по умолчанию (имя => значение), которые предоставляет это правило. Когда это правило используется для разбора входящего запроса, значения, объявленные в этом свойстве, будут внедрены в $_GET.

public array $defaults = []

$encodeParams общедоступное свойство

Значение, указывающее, должны ли параметры быть закодированы в URL.

public boolean $encodeParams = true

$host общедоступное свойство

Шаблон, используемый для разбора и создания части информации о хосте URL (например, http://example.com).

См. также $pattern.

public string $host = null

$mode общедоступное свойство

Значение, указывающее, должно ли это правило использоваться для разбора запроса и создания URL, только для разбора или только для создания. Если не задано или равно 0, это означает, что правило используется как для разбора запроса, так и для создания URL. Если оно равно PARSING_ONLY, правило используется только для разбора запроса. Если оно равно CREATION_ONLY, правило используется только для создания URL.

public integer $mode = null

$name общедоступное свойство

Имя этого правила. Если не задано, оно будет использовать $pattern в качестве имени.

public string $name = null

$normalizer общедоступное свойство (доступно с версии 2.0.10)

Конфигурация для yii\web\UrlNormalizer, используемая этим правилом. Если null, будет использоваться yii\web\UrlManager::$normalizer, если false, нормализация будет пропущена для этого правила.

public yii\web\UrlNormalizer|array|false|null $normalizer = null

$pattern общедоступное свойство

Шаблон, используемый для разбора и создания части пути URL.

См. также:

• $host
• $placeholders

public string $pattern = null

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

Список плейсхолдеров для сопоставления имен параметров. Используется в parseRequest(), createUrl(). При инициализации правила имена параметров из $pattern будут заменены на плейсхолдеры. Этот массив содержит соответствия между исходными именами параметров и их плейсхолдерами. Ключами массива являются плейсхолдеры, а значениями — исходные имена.

См. также:

• parseRequest()
• createUrl()

protected array $placeholders = []

$route общедоступное свойство

Маршрут к действию контроллера

public string $route = null

$suffix общедоступное свойство

Суффикс URL, используемый для этого правила. Например, ".html" можно использовать, чтобы URL выглядел как ссылка на статическую HTML-страницу. Если не задано, используется значение yii\web\UrlManager::$suffix.

public string $suffix = null

$verb общедоступное свойство

HTTP-глагол (например, GET, POST, DELETE), которому должно соответствовать это правило. Используйте массив для представления нескольких глаголов, которым может соответствовать это правило. Если это свойство не задано, правило может соответствовать любому глаголу. Обратите внимание, что это свойство используется только при разборе запроса. Оно игнорируется при создании URL.

public string|array $verb = null

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