RouteProviderLazyBuilder
class RouteProviderLazyBuilder implements PreloadableRouteProviderInterface, EventSubscriberInterface (View source)
A Route Provider front-end for all Drupal-stored routes.
Properties
| protected RouteProviderInterface | $routeProvider | The route provider service. |
|
| protected RouteBuilderInterface | $routeBuilder | The route building service. |
|
| protected bool | $rebuilt | Flag to determine if the router has been rebuilt. |
|
| protected bool | $rebuilding | Flag to determine if router is currently being rebuilt. |
Methods
RouteProviderLazyBuilder constructor.
Gets the real route provider service and rebuilds the router id necessary.
Finds routes that may potentially match the request.
Find the route using the provided route name.
Pre-load routes by their names using the provided list of names.
Find many routes by their names using the provided list of names.
Get all routes which match a certain pattern.
Returns all the routes on the system.
Resets the route provider object.
Determines if the router has been rebuilt.
{@inheritdoc}
Sets the router rebuilding flag to TRUE.
Sets the router rebuilding flag to FALSE.
Details
__construct(RouteProviderInterface $route_provider, RouteBuilderInterface $route_builder)
RouteProviderLazyBuilder constructor.
protected RouteProviderInterface
getRouteProvider()
Gets the real route provider service and rebuilds the router id necessary.
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.
preLoadRoutes(string[] $names)
Pre-load routes by their names using the provided list of names.
This method exists in order to allow performance optimizations. It allows pre-loading serialized routes that may latter be retrieved using ::getRoutesByName()
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.
Route[]
getRoutesPaged(int $offset, int $length = NULL)
deprecated
deprecated
Returns a chunk of routes.
Should only be used in conjunction with an iterator.
int
getRoutesCount()
deprecated
deprecated
Gets the total count of routes provided by the router.
bool
hasRebuilt()
Determines if the router has been rebuilt.
static
getSubscribedEvents()
{@inheritdoc}
routerRebuilding()
Sets the router rebuilding flag to TRUE.
routerRebuildFinished()
Sets the router rebuilding flag to FALSE.