class Router extends Router implements WarmableInterface
This Router creates the Loader only when the cache is empty.
Methods
| __construct(ContainerInterface $container, mixed $resource, array $options = array(), RequestContext $context = null) Constructor. | ||
| setOptions(array $options) Sets options. | from Router | |
| setOption(string $key, mixed $value) Sets an option. | from Router | |
| mixed | getOption(string $key) Gets an option value. | from Router |
| RouteCollection | getRouteCollection() Gets the RouteCollection instance associated with this Router. | |
| setContext(RequestContext $context) Sets the request context. | from Router | |
| RequestContext | getContext() Gets the request context. | from Router |
| setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) Sets the ConfigCache factory to use. | from Router | |
| 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. | from Router |
| array | match(string $pathinfo) Tries to match a URL path with a set of routes. | from Router |
| array | matchRequest(Request $request) Tries to match a request with a set of routes. | from Router |
| UrlMatcherInterface | getMatcher() Gets the UrlMatcher instance associated with this Router. | from Router |
| UrlGeneratorInterface | getGenerator() Gets the UrlGenerator instance associated with this Router. | from Router |
| addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider) | from Router | |
| warmUp(string $cacheDir) Warms up the cache. |
Details
__construct(ContainerInterface $container, mixed $resource, array $options = array(), RequestContext $context = null)
Constructor.
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)
- resource_type: Type hint for the main resource (optional)
setOption(string $key, mixed $value)
Sets an option.
mixed getOption(string $key)
Gets an option value.
RouteCollection getRouteCollection()
Gets the RouteCollection instance associated with this Router.
setContext(RequestContext $context)
Sets the request context.
RequestContext getContext()
Gets the request context.
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 = ABSOLUTEPATH but the route requires the https scheme whereas the current scheme is http, it will instead return an ABSOLUTEURL 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.
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.
UrlMatcherInterface getMatcher()
Gets the UrlMatcher instance associated with this Router.
UrlGeneratorInterface getGenerator()
Gets the UrlGenerator instance associated with this Router.
addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
warmUp(string $cacheDir)
Warms up the cache.
Please login to continue.