Получить параметры шаблона маршрута Route::getParameters

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

Метод Route::getParameters возвращает параметры шаблона маршрута и их регулярные выражения. Метод compile заполняет список. Метод getParametersValues возвращает значения параметров из пути запроса.

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

public function getParameters()

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

Метод возвращает массив. Ключи — имена параметров, значения — регулярные выражения, например ['code' => '[^/]+']. Для шаблона без параметров после compile метод возвращает пустой массив.

До вызова compile метод возвращает null. Метод не вызывает compile сам.

Примеры

Пример. Код строит выражение маршрута и выводит параметры шаблона:

<?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}/{page}/', static fn() => 'unit');
$route->setOptions($options);
$route->compile();

var_export($route->getParameters());

Код выведет:

array (
  'code' => '[a-z]+',
  'page' => '[^/]+',
)

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