Router — обработчики предпросмотра внутренних ссылок
Пространство имен: Bitrix\Main\UrlPreview
Модуль: main — подключать отдельно не нужно
Доступно с версии: 16.0.0
Когда использовать
Класс Router связывает шаблоны внутренних адресов сайта с классами, которые строят предпросмотр ссылки. Когда пользователь вставляет внутреннюю ссылку, например в сообщение, класс Bitrix\Main\UrlPreview\UrlPreview находит обработчик через dispatch и вызывает его методы.
Модуль регистрирует свои шаблоны методом setRouteHandler один раз. Метод сохраняет маршрут в базе данных, и маршрут действует в следующих запросах.
Класс обработчика может реализовать статические методы:
buildPreview(array $params)— возвращает HTML-код предпросмотра,checkUserReadAccess(array $params, int $userId)— возвращаетtrue, если у пользователя есть доступ на чтение,getCacheTag()— возвращает тег кеша для предпросмотра,getImAttach(array $params)иgetImRich(array $params)— возвращают результат одноименных методов классаUrlPreview.
Класс UrlPreview проверяет каждый метод через method_exists. Если метода checkUserReadAccess нет, класс UrlPreview не строит предпросмотр с проверкой доступа.
Этот класс не связан с маршрутизатором приложения Bitrix\Main\Routing\Router.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| setRouteHandler | Регистрирует или изменяет обработчик для шаблона адреса | |
| dispatch | Находит обработчик для адреса и подставляет параметры из адреса | |
| invalidateRouteCache | Очищает кеш маршрутов |
Константы
| Константа | Значение | Описание |
|---|---|---|
CACHE_ID |
UrlPreviewRouteCache |
Идентификатор управляемого кеша с маршрутами |
CACHE_TTL |
315360000 |
Время жизни кеша маршрутов в секундах |