Router — маршрутизатор приложения

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

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

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

Класс Router хранит маршруты приложения. Метод Application::getInstance()->getRouter() возвращает готовый объект. Класс ServiceLocator возвращает тот же объект по имени класса Router.

При первом вызове getRouter приложение создает объект и подключает файлы маршрутов:

  • файлы из секции routing конфигурации ядра — по имени файла из каталогов /local/routes/ и /bitrix/routes/,
  • системные файлы из секции routing файла /bitrix/routes/.settings.php.

Затем приложение вызывает releaseRoutes. Метод route строит URL по имени маршрута, метод match находит маршрут для запроса.

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

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

Метод Описание С версии
route Строит URL по имени маршрута и значениям параметров
url Добавляет к URL строку запроса из массива параметров
match Находит маршрут, который подходит запросу
getRoutes Возвращает список маршрутов
registerConfiguration Добавляет настройку, из которой releaseRoutes создает маршрут
releaseRoutes Переносит маршруты из добавленных настроек в список маршрутов

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