Documentation

Router
in package
implements RouterInterface, RequestMatcherInterface

The Router class is an example of the integration of all pieces of the routing system for easier use.

Tags
author

Fabien Potencier fabien@symfony.com

Interfaces, Classes and Traits

RouterInterface
RouterInterface is the interface that all Router classes must implement.
RequestMatcherInterface
RequestMatcherInterface is the interface that all request matcher classes must implement.

Table of Contents

$collection  : RouteCollection|null
$context  : RequestContext
$defaultLocale  : string|null
$generator  : UrlGeneratorInterface|null
$loader  : LoaderInterface
$logger  : LoggerInterface|null
$matcher  : UrlMatcherInterface|null
$options  : array<string|int, mixed>
$resource  : mixed
$cache  : mixed
$configCacheFactory  : ConfigCacheFactoryInterface|null
$expressionLanguageProviders  : array<string|int, ExpressionFunctionProviderInterface>
__construct()  : mixed
addExpressionLanguageProvider()  : mixed
generate()  : mixed
{@inheritdoc}
getContext()  : mixed
{@inheritdoc}
getGenerator()  : UrlGeneratorInterface
Gets the UrlGenerator instance associated with this Router.
getMatcher()  : UrlMatcherInterface|RequestMatcherInterface
Gets the UrlMatcher or RequestMatcher instance associated with this Router.
getOption()  : mixed
Gets an option value.
getRouteCollection()  : RouteCollection
Gets the RouteCollection instance associated with this Router.
match()  : mixed
{@inheritdoc}
matchRequest()  : array<string|int, mixed>
Tries to match a request with a set of routes.
setConfigCacheFactory()  : mixed
Sets the ConfigCache factory to use.
setContext()  : mixed
{@inheritdoc}
setOption()  : mixed
Sets an option.
setOptions()  : mixed
Sets options.
getGeneratorDumperInstance()  : GeneratorDumperInterface
getMatcherDumperInstance()  : MatcherDumperInterface
getCompiledRoutes()  : array<string|int, mixed>
getConfigCacheFactory()  : ConfigCacheFactoryInterface
Provides the ConfigCache factory implementation, falling back to a default implementation if necessary.

Properties

$defaultLocale

protected string|null $defaultLocale

$options

protected array<string|int, mixed> $options = []

$resource

protected mixed $resource

$cache

private static mixed $cache = []

Methods

__construct()

public __construct(LoaderInterface $loader, mixed $resource[, array<string|int, mixed> $options = [] ][, RequestContext|null $context = null ][, LoggerInterface|null $logger = null ][, string|null $defaultLocale = null ]) : mixed
Parameters
$loader : LoaderInterface
$resource : mixed

The main resource to load

$options : array<string|int, mixed> = []
$context : RequestContext|null = null
$logger : LoggerInterface|null = null
$defaultLocale : string|null = null
Return values
mixed —

generate()

{@inheritdoc}

public generate(string $name[, array<string|int, mixed> $parameters = [] ][, int $referenceType = self::ABSOLUTE_PATH ]) : mixed
Parameters
$name : string
$parameters : array<string|int, mixed> = []
$referenceType : int = self::ABSOLUTE_PATH
Return values
mixed —

getContext()

{@inheritdoc}

public getContext() : mixed
Return values
mixed —

getOption()

Gets an option value.

public getOption(string $key) : mixed
Parameters
$key : string
Tags
throws
InvalidArgumentException
Return values
mixed —

match()

{@inheritdoc}

public match(string $pathinfo) : mixed
Parameters
$pathinfo : string
Return values
mixed —

matchRequest()

Tries to match a request with a set of routes.

public matchRequest(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed> —

setOption()

Sets an option.

public setOption(string $key, mixed $value) : mixed
Parameters
$key : string
$value : mixed

The value

Tags
throws
InvalidArgumentException
Return values
mixed —

setOptions()

Sets options.

public setOptions(array<string|int, mixed> $options) : mixed

Available options:

  • cache_dir: The cache directory (or null to disable caching)
  • debug: Whether to enable debugging or not (false by default)
  • generator_class: The name of a UrlGeneratorInterface implementation
  • generator_dumper_class: The name of a GeneratorDumperInterface implementation
  • matcher_class: The name of a UrlMatcherInterface implementation
  • matcher_dumper_class: The name of a MatcherDumperInterface implementation
  • resource_type: Type hint for the main resource (optional)
  • strict_requirements: Configure strict requirement checking for generators implementing ConfigurableRequirementsInterface (default is true)
Parameters
$options : array<string|int, mixed>
Tags
throws
InvalidArgumentException

When unsupported option is provided

Return values
mixed —

getCompiledRoutes()

private static getCompiledRoutes(string $path) : array<string|int, mixed>
Parameters
$path : string
Return values
array<string|int, mixed> —

Search results