Класс yii\web\GroupUrlRule

GroupUrlRule представляет собой коллекцию правил URL, которые используют один и тот же префикс в своих шаблонах и маршрутах.

GroupUrlRule лучше всего использовать в модуле, который часто использует идентификатор модуля в качестве префикса для правил URL. Например, следующий код создаёт правило для модуля admin:

new GroupUrlRule([
    'prefix' => 'admin',
    'rules' => [
        'login' => 'user/login',
        'logout' => 'user/logout',
        'dashboard' => 'default/dashboard',
    ],
]);

// the above rule is equivalent to the following three rules:

[
    'admin/login' => 'admin/user/login',
    'admin/logout' => 'admin/user/logout',
    'admin/dashboard' => 'admin/default/dashboard',
]

В приведенном выше примере предполагается, что префикс для шаблонов и маршрутов одинаков. Их можно сделать разными, настроив $prefix и $routePrefix отдельно.

Использование GroupUrlRule более эффективно, чем непосредственное объявление отдельных правил, которые оно содержит. Это связано с тем, что GroupUrlRule может быстро определить, нужно ли обрабатывать запрос на разбор или создание URL, просто проверив, совпадает ли префикс.

Свойства

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

Методы

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

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

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

Префикс для части шаблона каждого правила, объявленного в $rules. Префикс и шаблон будут разделены слэшем.

public string $prefix = null

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

Префикс для части маршрута каждого правила, объявленного в $rules. Префикс и маршрут будут разделены слэшем. Если это свойство не задано, оно примет значение свойства $prefix.

public string $routePrefix = null

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

Настройка по умолчанию для правил URL. Индивидуальные настройки правил, указанные через $rules, будут иметь приоритет при настройке одного и того же свойства правила.

public array $ruleConfig = ['class' => 'yii\web\UrlRule']

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

Правила, содержащиеся в этом составном правиле. См. yii\web\UrlManager::$rules для формата этого свойства.

См. также:

• $prefix
• $routePrefix

public array $rules = []

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