Задать настройки маршрута Route::setOptions
Модуль: main — подключать отдельно не нужно
Метод Route::setOptions задает маршруту объект настроек. Метод release класса RoutingConfiguration вызывает setOptions, когда метод Router::releaseRoutes переносит маршруты в маршрутизатор.
Сигнатура метода в классе Bitrix\Main\Routing\Route:
public function setOptions($options)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| options* | Bitrix\Main\Routing\Options |
Задает настройки маршрута |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод ничего не возвращает.
Особенности
- Метод match читает значения по умолчанию из настроек. Без настроек метод
matchвызывает ошибкуError, когда путь подходит под шаблон. - Методы getUri и 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]+');
$options->default('view', 'short');
$route = new Route('/units/{code}/', static fn() => 'unit');
$route->setOptions($options);
var_export($route->match('/units/kg/'));
Код выведет:
array (
'code' => 'kg',
'view' => 'short',
)
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая