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

класс Router реализует RouterInterface, RequestMatcherInterface

Класс Router — пример интеграции всех компонентов системы маршрутизации для удобного использования.

Методы

	__construct(LoaderInterface $loader, mixed $resource, array $options = array(), RequestContext $context = null, LoggerInterface $logger = null)
	setOptions(array $options) Устанавливает параметры.
	setOption(string $key, mixed $value) Устанавливает параметр.
mixed	getOption(string $key) Получает значение параметра.
RouteCollection	getRouteCollection() Получает экземпляр RouteCollection, связанный с этим маршрутизатором.
	setContext(RequestContext $context) Устанавливает контекст запроса.
RequestContext	getContext() Получает контекст запроса.
	setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) Устанавливает фабрику кэша конфигурации.
string	generate(string $name, mixed $parameters = array(), bool\|string $referenceType = self::ABSOLUTE_PATH) Генерирует URL или путь для определенного маршрута на основе заданных параметров.
array	match(string $pathinfo) Пытается сопоставить URL-путь с набором маршрутов.
array	matchRequest(Request $request) Пытается сопоставить запрос с набором маршрутов.
UrlMatcherInterface	getMatcher() Получает экземпляр UrlMatcher, связанный с этим маршрутизатором.
UrlGeneratorInterface	getGenerator() Получает экземпляр UrlGenerator, связанный с этим маршрутизатором.
	addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
GeneratorDumperInterface	getGeneratorDumperInstance() Этот метод публичный, так как он должен вызываться из замыкания в PHP 5.3. В версии 3.0 он должен стать защищённым.
MatcherDumperInterface	getMatcherDumperInstance() Этот метод публичный, так как он должен вызываться из замыкания в PHP 5.3. В версии 3.0 он должен стать защищённым.

Подробности

__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)
generator_class: Имя реализации UrlGeneratorInterface
generator_base_class: Базовый класс для сгенерированного класса генератора
generator_cache_class: Имя класса для сгенерированного класса генератора
generator_dumper_class: Имя реализации GeneratorDumperInterface
matcher_class: Имя реализации UrlMatcherInterface
matcher_base_class: Базовый класс для сгенерированного класса матчера
matcher_dumper_class: Имя класса для сгенерированного класса матчера
matcher_cache_class: Имя реализации MatcherDumperInterface
resource_type: Тип подсказки для основного ресурса (необязательно)
strict_requirements: Настроить строгую проверку требований для генераторов, реализующих ConfigurableRequirementsInterface (по умолчанию true)

Параметры

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(), bool|string $referenceType = self::ABSOLUTE_PATH)

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

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

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

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

Параметры

string	$name	Имя маршрута
mixed	$parameters	Массив параметров
bool\|string	$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	Если соответствующий ресурс найден, но метод запроса не разрешен