Проверить путь по шаблону маршрута Route::match

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

Метод Route::match проверяет, подходит ли путь под шаблон маршрута, и возвращает значения параметров. Метод не проверяет HTTP-метод и не сохраняет значения в маршруте. Метод Router::match вызывает Route::match для каждого маршрута, проверяет HTTP-метод и сохраняет значения.

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

public function match($uriPath)

Параметры

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

Параметр Тип Описание
uriPath* string Задает путь без строки запроса и без домена, например /units/kg/. Метод Router::match передает путь после urldecode

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

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

Результат Когда
array Путь подходит под шаблон с параметрами. Ключи — имена параметров, значения — части пути. Для пустого параметра со значением по умолчанию метод подставляет это значение. Метод добавляет и значения по умолчанию для имен, которых нет в шаблоне
array или true Путь совпадает с шаблоном без параметров. Метод возвращает массив значений по умолчанию, а если их нет — true
false Путь не подходит под шаблон

Особенности

  • Метод проверяет шаблон с фигурными скобками регулярным выражением из метода compile. Шаблон без фигурных скобок метод сравнивает с путем посимвольно. Например, путь /units не подходит под шаблон /units/.
  • Перед вызовом задайте маршруту настройки методом setOptions. Без настроек метод вызывает ошибку Error, когда путь подходит под шаблон.

Примеры

Пример. Код проверяет два пути по шаблону, в котором код единицы состоит из латинских букв:

<?php
use Bitrix\Main\Routing\Options;
use Bitrix\Main\Routing\Route;

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

$options = new Options();
$options->where('code', '[a-z]+');

$route = new Route('/units/{code}/', static fn() => 'unit');
$route->setOptions($options);

var_export($route->match('/units/kg/'));
echo ' ';
var_export($route->match('/units/12/'));

Код выведет:

array (
  'code' => 'kg',
) false

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