class RouteProviderLazyBuilder in Drupal 9

A Route Provider front-end for all Drupal-stored routes.

Hierarchy

• class \Drupal\Core\Routing\RouteProviderLazyBuilder implements \Symfony\Component\EventDispatcher\EventSubscriberInterface, PreloadableRouteProviderInterface

1 file declares its use of RouteProviderLazyBuilder

InstallerRouteProviderLazyBuilder.php in core/lib/Drupal/Core/Installer/InstallerRouteProviderLazyBuilder.php

1 string reference to 'RouteProviderLazyBuilder'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses RouteProviderLazyBuilder

router.route_provider.lazy_builder in core/core.services.yml

Drupal\Core\Routing\RouteProviderLazyBuilder

File

core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php, line 11

Namespace

Drupal\Core\Routing

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();
  }

  /**
   * Returns a chunk of routes.
   *
   * Should only be used in conjunction with an iterator.
   *
   * @param int $offset
   *   The query offset.
   * @param int $length
   *   The number of records.
   *
   * @return \Symfony\Component\Routing\Route[]
   *   Routes keyed by the route name.
   *
   * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct
   *   replacement is provided.
   *
   * @see https://www.drupal.org/node/3151009
   */
  public function getRoutesPaged($offset, $length = NULL) {
    @trigger_error(__METHOD__ . '() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct replacement is provided. See https://www.drupal.org/node/3151009', E_USER_DEPRECATED);
    return $this
      ->getRouteProvider()
      ->getRoutesPaged($offset, $length);
  }

  /**
   * Gets the total count of routes provided by the router.
   *
   * @return int
   *   Number of routes.
   *
   * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct
   *   replacement is provided.
   *
   * @see https://www.drupal.org/node/3151009
   */
  public function getRoutesCount() {
    @trigger_error(__METHOD__ . '() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct replacement is provided. See https://www.drupal.org/node/3151009', E_USER_DEPRECATED);
    return $this
      ->getRouteProvider()
      ->getRoutesCount();
  }

  /**
   * 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() {
    $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

Name	Modifiers	Type	Description	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::getRoutesCount Deprecated	public	function	Gets the total count of routes provided by the router.
RouteProviderLazyBuilder::getRoutesPaged Deprecated	public	function	Returns a chunk of routes.
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.