Route — маршрут

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

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

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

Объект Route описывает один маршрут: шаблон URL, обработчик и настройки. Конфигуратор маршрутов RoutingConfigurator создает объекты из файлов маршрутов, поэтому создавать их конструктором в коде приложения не нужно.

Чтобы прочитать параметры текущего маршрута, получите объект одним из способов:

  • метод Router::match возвращает маршрут, который подходит запросу, и заполняет значения его параметров,
  • метод Application::getInstance()->getCurrentRoute() возвращает маршрут текущего запроса, метод hasCurrentRoute проверяет, что он есть,
  • обработчик-замыкание получает маршрут, если объявит параметр с типом Route.

Метод getParameterValue возвращает значение параметра, метод getParametersValues — значения всех параметров.

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

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

Метод Описание С версии
__construct Создает маршрут из шаблона URL и обработчика
getUri Возвращает шаблон URL с префиксом группы
getController Возвращает обработчик маршрута
getOptions Возвращает настройки маршрута
setOptions Задает настройки маршрута
getParameterValue Возвращает значение параметра из пути запроса
getParametersValues Возвращает значения всех параметров из пути запроса
match Проверяет путь по шаблону и возвращает значения параметров
compile Строит регулярное выражение по шаблону
getParameters Возвращает параметры шаблона и их регулярные выражения
getCompileCache Возвращает регулярное выражение и параметры для кеша
compileFromCache Загружает регулярное выражение и параметры из кеша

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