Класс yii\rest\UrlRule

UrlRule предназначен для упрощения создания правил URL для поддержки RESTful API.

Самое простое использование UrlRule заключается в объявлении правила в конфигурации приложения, как показано ниже:

[
    'class' => 'yii\rest\UrlRule',
    'controller' => 'user',
]

Вышеуказанный код создаст целый набор правил URL, поддерживающих следующие конечные точки RESTful API:

• 'PUT,PATCH users/<id>' => 'user/update': обновление пользователя
• 'DELETE users/<id>' => 'user/delete': удаление пользователя
• 'GET,HEAD users/<id>' => 'user/view': вывод подробной информации/обзора/вариантов пользователя
• 'POST users' => 'user/create': создание нового пользователя
• 'GET,HEAD users' => 'user/index': вывод списка/обзора/вариантов пользователей
• 'users/<id>' => 'user/options': обработка всех необработанных глаголов пользователя
• 'users' => 'user/options': обработка всех необработанных глаголов коллекции пользователей

Вы можете настроить $only и/или $except, чтобы отключить некоторые из вышеуказанных правил. Вы можете настроить $patterns, чтобы полностью переопределить свой собственный список правил. Вы можете настроить $controller с несколькими идентификаторами контроллеров, чтобы сгенерировать правила для всех этих контроллеров. Например, следующий код отключит правило delete и сгенерирует правила для контроллеров user и post.

[
    'class' => 'yii\rest\UrlRule',
    'controller' => ['user', 'post'],
    'except' => ['delete'],
]

Свойство $controller является обязательным и должно представлять один или несколько идентификаторов контроллеров. Каждый идентификатор контроллера должен быть префиксами идентификатором модуля, если контроллер находится в модуле. Идентификатор контроллера, используемый в шаблоне, будет автоматически приведен к множественному числу (например, user становится users, как показано в примерах выше).

Для получения более подробной информации и сведений об использовании UrlRule, см. статью руководства по маршрутизации REST.

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

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

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

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

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

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

Идентификатор контроллера (например, user, post-comment) для которого применяются правила в этом составном правиле. Он должен быть префиксён идентификатором модуля, если контроллер находится в модуле (например, admin/user).

По умолчанию идентификатор контроллера будет автоматически приведен к множественному числу, когда он используется в шаблонах создаваемых правил. Если вы хотите явно указать, как идентификатор контроллера должен отображаться в шаблонах, вы можете использовать массив, где ключ массива является идентификатором контроллера в шаблоне, а значение — фактическим идентификатором контроллера. Например, ['u' => 'user'].

Вы также можете передать несколько идентификаторов контроллеров в виде массива. В этом случае это составное правило сгенерирует применимые правила URL для КАЖДОГО указанного контроллера. Например, ['user', 'post'].

public string|array $controller = null

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

Список действий, которые должны быть исключены. Любое действие, найденное в этом массиве, НЕ будет иметь созданных правил URL.

См. также $patterns.

public array $except = []

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

Шаблоны для поддержки дополнительных действий помимо тех, что указаны в $patterns. Ключи — это шаблоны, а значения — соответствующие идентификаторы действий. Эти дополнительные шаблоны будут иметь приоритет над $patterns.

public array $extraPatterns = []

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

Список допустимых действий. Если не пусто, только действия в этом массиве будут иметь соответствующие правила URL.

См. также $patterns.

public array $only = []

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

Список возможных шаблонов и соответствующих действий для создания правил URL. Ключи — это шаблоны, а значения — соответствующие действия. Формат шаблонов Verbs Pattern, где Verbs обозначает список HTTP-глаголов, разделённых запятыми (без пробелов). Если Verbs не указан, разрешены все глаголы. Pattern является необязательным. Он будет префиксён $prefix/$controller/, а токены в нём будут заменены на $tokens.

public array $patterns = ['PUT,PATCH {id}' => 'update', 'DELETE {id}' => 'delete', 'GET,HEAD {id}' => 'view', 'POST' => 'create', 'GET,HEAD' => 'index', '{id}' => 'options', '' => 'options']

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

Автоматически ли приводить названия контроллеров к множественному числу в именах URL. Если true, идентификатор контроллера будет отображаться во множественном числе в URL. Например, контроллер user будет отображаться как users в URL.

См. также $controller.

public boolean $pluralize = true

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

Общий префикс, используемый всеми шаблонами.

public string $prefix = null

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

Настройки по умолчанию для создания каждого правила URL, содержащегося в этом правиле.

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

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

Суффикс, который будет назначен yii\web\UrlRule::$suffix для каждого сгенерированного правила.

public string $suffix = null

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

Список токенов, которые должны быть заменены для каждого шаблона. Ключи — имена токенов, а значения — соответствующие замены.

См. также $patterns.

public array $tokens = ['{id}' => '<id:\\d[\\d,]*>']

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