Найти обработчик предпросмотра для адреса Router::dispatch

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

Метод Router::dispatch находит обработчик предпросмотра для адреса. Класс UrlPreview вызывает его, чтобы проверить, есть ли у внутренней ссылки свой предпросмотр.

Сигнатура метода в классе Bitrix\Main\UrlPreview\Router:

public static function dispatch(Uri $uri)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
uri* Bitrix\Main\Web\Uri Задает абсолютный или относительный адрес. Метод сравнивает с шаблонами только путь адреса

Возвращаемое значение

Метод возвращает массив маршрута первого подходящего шаблона или false, если шаблон не найден.

Ключ

Описание

ROUTE
string

Шаблон адреса

MODULE
string

Код модуля обработчика

CLASS
string

Имя класса обработчика

PARAMETERS
array

Параметры для методов обработчика после подстановки значений из адреса

ID
int

Идентификатор записи маршрута в базе данных

REGEXP
string

Регулярное выражение, которое метод построил из шаблона

Метод заменяет значение '$name' параметром name из пути адреса. Если в шаблоне пути такого параметра нет, метод берет значение параметра name из строки запроса адреса. Если значения нет ни в пути, ни в строке запроса, в массиве остается строка '$name'. Значения без $ в начале метод не меняет.

Особенности

При первом вызове в запросе метод читает маршруты из управляемого кеша или из базы данных. После чтения из базы данных метод сортирует шаблоны по длине и сохраняет их в кеш в этом порядке. Метод проверяет длинный шаблон раньше короткого. Новый шаблон, который зарегистрировали в текущем запросе, метод до конца запроса проверяет последним.

Примеры

Пример. Код проверяет, есть ли обработчик предпросмотра у адреса:

<?php
use Bitrix\Main\UrlPreview\Router;
use Bitrix\Main\Web\Uri;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$handler = Router::dispatch(new Uri('/demo/no-preview/'));

echo $handler === false ? 'No handler' : $handler['CLASS'];

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