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']`.

Исключения

\Bitrix\Main\ArgumentException

Примеры

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх