Routing\Options — настройки маршрута

Пространство имен: Bitrix\Main\Routing

Модуль: main — подключать отдельно не нужно

Когда использовать

Класс Options хранит настройки маршрута — HTTP-методы, префикс, имя, регулярные выражения и значения по умолчанию параметров. Метод Route::getOptions возвращает настройки маршрута.

В файле маршрутов объект создавать не нужно. Методы конфигуратора маршрутов RoutingConfigurator с теми же именами — prefix, name, where, default и другие — передают значения в объект Options и возвращают конфигурацию RoutingConfiguration для цепочки вызовов. Методы Options, которые задают настройки, ничего не возвращают.

Методы get* и has* читают настройки, например getFullName и getWhere.

Подробнее — в статье Роутинг.

Методы класса

Метод Описание С версии
methods Задает HTTP-методы маршрута
getMethods Возвращает HTTP-методы маршрута
prefix Задает префикс пути
hasPrefix Проверяет, задан ли префикс
getFullPrefix Возвращает префикс с префиксами родительских групп
name Задает имя маршрута или часть имени группы
hasName Проверяет, задано ли собственное имя
getFullName Возвращает полное имя с именами родительских групп
where Задает регулярное выражение параметра
hasWhere Проверяет, задано ли регулярное выражение параметра
getWhere Возвращает регулярные выражения параметров
default Задает значение параметра по умолчанию
hasDefault Проверяет, задано ли значение параметра по умолчанию
getDefault Возвращает значения параметров по умолчанию
middleware Добавляет промежуточный обработчик
domain Задает домен
mergeWith Добавляет настройки родительской группы
clearCurrent Сбрасывает собственные префикс и имя

Свойство optionList

Статическое свойство Options::$optionList содержит имена настроек methods, middleware, prefix, name, domain, where и default. Классы RoutingConfigurator и RoutingConfiguration передают в Options вызовы только с этими именами. Класс RoutingConfigurator принимает еще методы объявления маршрутов get, post, group и другие. Для остальных имен классы выбрасывают Bitrix\Main\SystemException.

Смотрите также