CacheableRouteProviderInterface
interface CacheableRouteProviderInterface implements RouteProviderInterface (View source)
Extends the router provider interface to provide caching support.
Methods
Finds routes that may potentially match the request.
Find the route using the provided route name.
Find many routes by their names using the provided list of names.
Get all routes which match a certain pattern.
Adds a cache key part to be used in the cache ID of the route collection.
Details
RouteCollection
getRouteCollectionForRequest(Request $request)
Finds routes that may potentially match the request.
This may return a mixed list of class instances, but all routes returned must extend the core Symfony route. The classes may also implement RouteObjectInterface to link to a content document.
This method may not throw an exception based on implementation specific restrictions on the url. That case is considered a not found - returning an empty array. Exceptions are only used to abort the whole request in case something is seriously broken, like the storage backend being down.
Note that implementations may not implement an optimal matching algorithm, simply a reasonable first pass. That allows for potentially very large route sets to be filtered down to likely candidates, which may then be filtered in memory more completely.
Route
getRouteByName(string $name)
Find the route using the provided route name.
Route[]
getRoutesByNames(array|null $names)
Find many routes by their names using the provided list of names.
Note that this method may not throw an exception if some of the routes are not found or are not actually Route instances. It will just return the list of those Route instances it found.
This method exists in order to allow performance optimizations. The simple implementation could be to just repeatedly call $this->getRouteByName() while catching and ignoring eventual exceptions.
If $names is null, this method SHOULD return a collection of all routes known to this provider. If there are many routes to be expected, usage of a lazy loading collection is recommended. A provider MAY only return a subset of routes to e.g. support paging or other concepts.
RouteCollection
getRoutesByPattern(string $pattern)
Get all routes which match a certain pattern.
Route[]
getAllRoutes()
Returns all the routes on the system.
Usage of this method is discouraged for performance reasons. If possible, use RouteProviderInterface::getRoutesByNames() or RouteProviderInterface::getRoutesByPattern() instead.
reset()
Resets the route provider object.
addExtraCacheKeyPart(string $cache_key_provider, string $cache_key_part)
Adds a cache key part to be used in the cache ID of the route collection.