Документация для разработчиков
Темная тема

setRouteHandler

void public static
\Bitrix\Main\UrlPreview\Router::setRouteHandler(
	string $route,
	string $handlerModule,
	string $handlerClass,
	array $handlerParameters
);

Статический метод добавляет или, если маршрут существует, изменяет метод обработки маршрута.

Параметры

ПараметрОписаниеВерсия
$routeШаблон URL маршрута. Параметры маршрута следует заключать в хеш символы, пример: /user/#userId#/.
$handlerModuleМодуль обработчика маршрута.
$handlerClassКласс обработчика маршрута должен применять методы:
  • buildPreview($params): string Метод должен принимать массив параметров и возвращать готовую "богатую ссылку".
  • checkUserReadAccess($params): boolean. Метод должен принимать массив параметров и возвращать true, если зарегистрированный пользователь успешно прочитал сущность и false в противном случае.
  • getCacheTag(): string. Метод должен возвращать тег кеша для сущности.
$handlerParametersМассив параметров отправляемых методом в обработчик. Массив должен быть передан как аргумент когда вызывается метод обработчика для создания "богатой ссылки" или проверки доступа. Массив значений должен содержать переменные, ссылающиеся на параметры маршрута, например: ['userId' => '$userId'].

Исключения

Примеры



© «Битрикс», 2001-2024, «1С-Битрикс», 2024