Drupal 8  8.0.2
RouteProvider Class Reference
Inheritance diagram for RouteProvider:

Public Member Functions

 getRouteCollectionForRequest (Request $request)
 
 getRouteByName ($name)
 
 preLoadRoutes ($names)
 
 getRoutesByNames ($names)
 
 getCandidateOutlines (array $parts)
 
 getRoutesByPattern ($pattern)
 
 routeProviderRouteCompare (array $a, array $b)
 
 getAllRoutes ()
 
 reset ()
 
 getRoutesPaged ($offset, $length=NULL)
 
 getRoutesCount ()
 

Protected Member Functions

 lazyLoadItself ()
 

Detailed Description

Rebuilds the router when the provider is instantiated.

Member Function Documentation

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.

Returns
[] An iterator of routes keyed by route name.
}

Implements RouteProviderInterface.

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getCandidateOutlines ( array  $parts)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRouteByName (   $name)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRouteCollectionForRequest ( Request  $request)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRoutesByNames (   $names)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRoutesByPattern (   $pattern)

{Get all routes which match a certain pattern.

Parameters
string$patternThe route pattern to search for (contains {} as placeholders).
Returns
Returns a route collection of matching routes.
}

Implements RouteProviderInterface.

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRoutesCount ( )

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

getRoutesPaged (   $offset,
  $length = NULL 
)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

lazyLoadItself ( )
protected

Loads the real route provider from the container and rebuilds the router.

Returns
|| The route provider.

References Drupal\getContainer(), and Drupal\service().

Referenced by RouteProvider\getAllRoutes(), RouteProvider\getCandidateOutlines(), RouteProvider\getRouteByName(), RouteProvider\getRouteCollectionForRequest(), RouteProvider\getRoutesByNames(), RouteProvider\getRoutesByPattern(), RouteProvider\getRoutesCount(), RouteProvider\getRoutesPaged(), RouteProvider\preLoadRoutes(), RouteProvider\reset(), and RouteProvider\routeProviderRouteCompare().

Here is the call graph for this function:

Here is the caller graph for this function:

preLoadRoutes (   $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.
}

Implements PreloadableRouteProviderInterface.

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

reset ( )

{Resets the route provider object.}

Implements RouteProviderInterface.

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:

routeProviderRouteCompare ( array  $a,
array  $b 
)

{}

References RouteProvider\lazyLoadItself().

Here is the call graph for this function:


The documentation for this class was generated from the following file: