1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. RouteProviderLazyBuilder

RouteProviderLazyBuilder

class RouteProviderLazyBuilder implements PreloadableRouteProviderInterface, PagedRouteProviderInterface, 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

__construct(RouteProviderInterface $route_provider, RouteBuilderInterface $route_builder)

RouteProviderLazyBuilder constructor.

RouteProviderInterface
getRouteProvider()

Gets the real route provider service and rebuilds the router id necessary.

getRouteCollectionForRequest(Request $request)

{@inheritdoc}

getRouteByName($name)

{@inheritdoc}

preLoadRoutes(string[] $names)

Pre-load routes by their names using the provided list of names.

getRoutesByNames($names)

{@inheritdoc}

RouteCollection
getRoutesByPattern(string $pattern)

Get all routes which match a certain pattern.

Route[]
getAllRoutes()

Returns all the routes on the system.

reset()

Resets the route provider object.

getRoutesPaged($offset, $length = NULL)

{@inheritdoc}

getRoutesCount()

{@inheritdoc}

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.

Details

at line 55
__construct(RouteProviderInterface $route_provider, RouteBuilderInterface $route_builder)

RouteProviderLazyBuilder constructor.

Parameters

RouteProviderInterface $route_provider

The route provider service.
RouteBuilderInterface $route_builder

The route building service.

at line 66
protected RouteProviderInterface getRouteProvider()

Gets the real route provider service and rebuilds the router id necessary.

Return Value

RouteProviderInterface

The route provider service.

at line 77
getRouteCollectionForRequest(Request $request)

{@inheritdoc}

Parameters

Request $request

at line 84
getRouteByName($name)

{@inheritdoc}

Parameters

$name

at line 91
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()

Parameters

string[] $names

Array of route names to load.

at line 98
getRoutesByNames($names)

{@inheritdoc}

Parameters

$names

at line 105
RouteCollection getRoutesByPattern(string $pattern)

Get all routes which match a certain pattern.

Parameters

string $pattern

The route pattern to search for (contains } as placeholders).

Return Value

RouteCollection

Returns a route collection of matching routes. The collection may be empty and will be sorted from highest to lowest fit (match of path parts) and then in ascending order by route name for routes with the same fit.

at line 112
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.

Return Value

Route[]

An iterator of routes keyed by route name.

at line 119
reset()

Resets the route provider object.

at line 127
getRoutesPaged($offset, $length = NULL)

{@inheritdoc}

Parameters

$offset
$length

at line 134
getRoutesCount()

{@inheritdoc}

at line 144
bool hasRebuilt()

Determines if the router has been rebuilt.

Return Value

bool

TRUE is the router has been rebuilt, FALSE if not.

at line 151
static getSubscribedEvents()

{@inheritdoc}

at line 160
routerRebuilding()

Sets the router rebuilding flag to TRUE.

at line 167
routerRebuildFinished()

Sets the router rebuilding flag to FALSE.