class RouteProviderLazyBuilder
Same name in other branches
- 9 core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php \Drupal\Core\Routing\RouteProviderLazyBuilder
- 8.9.x core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php \Drupal\Core\Routing\RouteProviderLazyBuilder
- 10 core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php \Drupal\Core\Routing\RouteProviderLazyBuilder
A Route Provider front-end for all Drupal-stored routes.
Hierarchy
- class \Drupal\Core\Routing\RouteProviderLazyBuilder implements \Drupal\Core\Routing\PreloadableRouteProviderInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
Expanded class hierarchy of RouteProviderLazyBuilder
1 file declares its use of RouteProviderLazyBuilder
- InstallerRouteProviderLazyBuilder.php in core/
lib/ Drupal/ Core/ Installer/ InstallerRouteProviderLazyBuilder.php
File
-
core/
lib/ Drupal/ Core/ Routing/ RouteProviderLazyBuilder.php, line 11
Namespace
Drupal\Core\RoutingView source
class RouteProviderLazyBuilder implements PreloadableRouteProviderInterface, EventSubscriberInterface {
/**
* The route provider service.
*
* @var \Drupal\Core\Routing\RouteProviderInterface
*/
protected $routeProvider;
/**
* The route building service.
*
* @var \Drupal\Core\Routing\RouteBuilderInterface
*/
protected $routeBuilder;
/**
* Flag to determine if the router has been rebuilt.
*
* @var bool
*/
protected $rebuilt = FALSE;
/**
* Flag to determine if router is currently being rebuilt.
*
* Used to prevent recursive router rebuilds during module installation.
* Recursive rebuilds can occur when route information is required by alter
* hooks that are triggered during a rebuild, for example,
* hook_menu_links_discovered_alter().
*
* @var bool
*/
protected $rebuilding = FALSE;
/**
* RouteProviderLazyBuilder constructor.
*
* @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
* The route provider service.
* @param \Drupal\Core\Routing\RouteBuilderInterface $route_builder
* The route building service.
*/
public function __construct(RouteProviderInterface $route_provider, RouteBuilderInterface $route_builder) {
$this->routeProvider = $route_provider;
$this->routeBuilder = $route_builder;
}
/**
* Gets the real route provider service and rebuilds the router id necessary.
*
* @return \Drupal\Core\Routing\RouteProviderInterface
* The route provider service.
*/
protected function getRouteProvider() {
if (!$this->rebuilt && !$this->rebuilding) {
$this->routeBuilder
->rebuild();
}
return $this->routeProvider;
}
/**
* {@inheritdoc}
*/
public function getRouteCollectionForRequest(Request $request) {
return $this->getRouteProvider()
->getRouteCollectionForRequest($request);
}
/**
* {@inheritdoc}
*/
public function getRouteByName($name) {
return $this->getRouteProvider()
->getRouteByName($name);
}
/**
* {@inheritdoc}
*/
public function preLoadRoutes($names) {
return $this->getRouteProvider()
->preLoadRoutes($names);
}
/**
* {@inheritdoc}
*/
public function getRoutesByNames($names) {
return $this->getRouteProvider()
->getRoutesByNames($names);
}
/**
* {@inheritdoc}
*/
public function getRoutesByPattern($pattern) {
return $this->getRouteProvider()
->getRoutesByPattern($pattern);
}
/**
* {@inheritdoc}
*/
public function getAllRoutes() {
return $this->getRouteProvider()
->getAllRoutes();
}
/**
* {@inheritdoc}
*/
public function reset() {
// Don't call getRouteProvider as this is results in recursive rebuilds.
return $this->routeProvider
->reset();
}
/**
* Determines if the router has been rebuilt.
*
* @return bool
* TRUE is the router has been rebuilt, FALSE if not.
*/
public function hasRebuilt() {
return $this->rebuilt;
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() : array {
$events[RoutingEvents::DYNAMIC][] = [
'routerRebuilding',
3000,
];
$events[RoutingEvents::FINISHED][] = [
'routerRebuildFinished',
-3000,
];
return $events;
}
/**
* Sets the router rebuilding flag to TRUE.
*/
public function routerRebuilding() {
$this->rebuilding = TRUE;
}
/**
* Sets the router rebuilding flag to FALSE.
*/
public function routerRebuildFinished() {
$this->rebuilding = FALSE;
$this->rebuilt = TRUE;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
RouteProviderLazyBuilder::$rebuilding | protected | property | Flag to determine if router is currently being rebuilt. | ||
RouteProviderLazyBuilder::$rebuilt | protected | property | Flag to determine if the router has been rebuilt. | ||
RouteProviderLazyBuilder::$routeBuilder | protected | property | The route building service. | ||
RouteProviderLazyBuilder::$routeProvider | protected | property | The route provider service. | ||
RouteProviderLazyBuilder::getAllRoutes | public | function | Returns all the routes on the system. | Overrides RouteProviderInterface::getAllRoutes | |
RouteProviderLazyBuilder::getRouteByName | public | function | Find the route using the provided route name. | Overrides RouteProviderInterface::getRouteByName | 1 |
RouteProviderLazyBuilder::getRouteCollectionForRequest | public | function | Finds routes that may potentially match the request. | Overrides RouteProviderInterface::getRouteCollectionForRequest | |
RouteProviderLazyBuilder::getRouteProvider | protected | function | Gets the real route provider service and rebuilds the router id necessary. | ||
RouteProviderLazyBuilder::getRoutesByNames | public | function | Find many routes by their names using the provided list of names. | Overrides RouteProviderInterface::getRoutesByNames | |
RouteProviderLazyBuilder::getRoutesByPattern | public | function | Get all routes which match a certain pattern. | Overrides RouteProviderInterface::getRoutesByPattern | |
RouteProviderLazyBuilder::getSubscribedEvents | public static | function | |||
RouteProviderLazyBuilder::hasRebuilt | public | function | Determines if the router has been rebuilt. | ||
RouteProviderLazyBuilder::preLoadRoutes | public | function | Pre-load routes by their names using the provided list of names. | Overrides PreloadableRouteProviderInterface::preLoadRoutes | |
RouteProviderLazyBuilder::reset | public | function | Resets the route provider object. | Overrides RouteProviderInterface::reset | |
RouteProviderLazyBuilder::routerRebuildFinished | public | function | Sets the router rebuilding flag to FALSE. | ||
RouteProviderLazyBuilder::routerRebuilding | public | function | Sets the router rebuilding flag to TRUE. | ||
RouteProviderLazyBuilder::__construct | public | function | RouteProviderLazyBuilder constructor. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.