Router
class Router implements RouterInterface, RequestMatcherInterface
The Router class is an example of the integration of all pieces of the routing system for easier use.
Properties
| protected UrlMatcherInterface|null | $matcher | ||
| protected UrlGeneratorInterface|null | $generator | ||
| protected RequestContext | $context | ||
| protected LoaderInterface | $loader | ||
| protected RouteCollection|null | $collection | ||
| protected mixed | $resource | ||
| protected array | $options | ||
| protected LoggerInterface|null | $logger |
Methods
No description
Sets options.
Sets an option.
Gets an option value.
Gets the RouteCollection instance associated with this Router.
Gets the request context.
Sets the ConfigCache factory to use.
Generates a URL or path for a specific route based on the given parameters.
Tries to match a URL path with a set of routes.
Gets the UrlMatcher instance associated with this Router.
Gets the UrlGenerator instance associated with this Router.
No description
No description
Details
__construct(LoaderInterface $loader, mixed $resource, array $options = array(), RequestContext $context = null, LoggerInterface $logger = null)
setOptions(array $options)
Sets options.
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_base_class: The base class for the dumped generator class
- generator_cache_class: The class name for the dumped generator class
- generator_dumper_class: The name of a GeneratorDumperInterface implementation
- matcher_class: The name of a UrlMatcherInterface implementation
- matcher_base_class: The base class for the dumped matcher class
- matcher_dumper_class: The class name for the dumped matcher class
- matcher_cache_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)
setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)
Sets the ConfigCache factory to use.
string
generate(string $name, mixed $parameters = array(), int $referenceType = self::ABSOLUTE_PATH)
Generates a URL or path for a specific route based on the given parameters.
Parameters that reference placeholders in the route pattern will substitute them in the path or host. Extra params are added as query string to the URL.
When the passed reference type cannot be generated for the route because it requires a different host or scheme than the current one, the method will return a more comprehensive reference that includes the required params. For example, when you call this method with $referenceType = ABSOLUTE_PATH but the route requires the https scheme whereas the current scheme is http, it will instead return an ABSOLUTE_URL with the https scheme and the current host. This makes sure the generated URL matches the route in any case.
If there is no route with the given name, the generator must throw the RouteNotFoundException.
The special parameter _fragment will be used as the document fragment suffixed to the final URL.
array
match(string $pathinfo)
Tries to match a URL path with a set of routes.
If the matcher can not find information, it must throw one of the exceptions documented below.
array
matchRequest(Request $request)
Tries to match a request with a set of routes.
If the matcher can not find information, it must throw one of the exceptions documented below.