Маршрутизатор

__construct(LoaderInterface $loader, mixed $resource, array $options = array(), RequestContext $context = null, LoggerInterface $logger = null)

Конструктор.

Параметры

LoaderInterface	$loader	Экземпляр LoaderInterface
mixed	$resource	Основной ресурс для загрузки
array	$options	Массив опций
RequestContext	$context	Контекст
LoggerInterface	$logger	Экземпляр логгера

setOptions(array $options)

Устанавливает опции.

Доступные опции:

• cache_dir: Каталог кэша (или null для отключения кэширования)
• debug: Включить отладку (по умолчанию false)
• resource_type: Тип подсказки для основного ресурса (необязательно)

Параметры

array

$options

Массив опций

Исключения

InvalidArgumentException

При предоставлении неподдерживаемой опции

setOption(string $key, mixed $value)

Устанавливает опцию.

Параметры

string	$key	Ключ
mixed	$value	Значение

Исключения

InvalidArgumentException

mixed getOption(string $key)

Получает значение опции.

Параметры

string

$key

Ключ

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

mixed

Значение

Исключения

InvalidArgumentException

RouteCollection getRouteCollection()

Получает экземпляр RouteCollection, связанный с этим маршрутизатором.

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

RouteCollection

Экземпляр RouteCollection

setContext(RequestContext $context)

Устанавливает контекст запроса.

Параметры

RequestContext

$context

Контекст

RequestContext getContext()

Получает контекст запроса.

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

RequestContext

Контекст

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Устанавливает фабрику ConfigCache для использования.

Параметры

ConfigCacheFactoryInterface

$configCacheFactory

Фабрика для использования.

string generate(string $name, mixed $parameters = array(), int $referenceType = self::ABSOLUTE_PATH)

Генерирует URL или путь для определенного маршрута на основе заданных параметров.

Параметры, ссылающиеся на заполнитель в шаблоне маршрута, заменят их в пути или хосте. Дополнительные параметры добавляются в строку запроса к URL.

Когда указанный тип ссылки не может быть сгенерирован для маршрута, потому что он требует другого хоста или схемы, чем текущий, метод вернёт более полную ссылку, которая включает необходимые параметры. Например, при вызове этого метода с $referenceType = ABSOLUTE_PATH, но маршрут требует схемы https, а текущая схема — http, он вместо этого вернёт ABSOLUTE_URL со схемой https и текущим хостом. Это гарантирует, что сгенерированный URL соответствует маршруту в любом случае.

Если маршрута с заданным именем не существует, генератор должен выбросить RouteNotFoundException.

Параметры

string	$name	Имя маршрута
mixed	$parameters	Массив параметров
int	$referenceType	Тип ссылки для генерации (одна из констант)

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

string

Сгенерированный URL

Исключения

RouteNotFoundException	Если указанный маршрут не существует
MissingMandatoryParametersException	Если отсутствуют обязательные параметры для маршрута
InvalidParameterException	Если значение параметра для заполнителя некорректно, не соответствует требованиям

array match(string $pathinfo)

Попытка сопоставить URL-путь с набором маршрутов.

Если согласование не найдено, метод должен выбросить одно из исключений, описанных ниже.

Параметры

string

$pathinfo

Путь для анализа (в исходном формате, т.е. без URL-декодирования)

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

array

Массив параметров

Исключения

ResourceNotFoundException	Если ресурс не найден
MethodNotAllowedException	Если ресурс найден, но метод запроса не разрешён

array matchRequest(Request $request)

Попытка сопоставить запрос с набором маршрутов.

Если согласование не найдено, метод должен выбросить одно из исключений, описанных ниже.

Параметры

Request

$request

Запрос для сопоставления

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

array

Массив параметров

Исключения

ResourceNotFoundException	Если не найден соответствующий ресурс
MethodNotAllowedException	Если соответствующий ресурс найден, но метод запроса не разрешён

UrlMatcherInterface getMatcher()

Получает экземпляр UrlMatcher, связанный с этим маршрутизатором.

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

UrlMatcherInterface

Экземпляр UrlMatcherInterface

UrlGeneratorInterface getGenerator()

Получает экземпляр UrlGenerator, связанный с этим маршрутизатором.

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

UrlGeneratorInterface

Экземпляр UrlGeneratorInterface

addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)

Параметры

ExpressionFunctionProviderInterface

$provider