1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. RouteBuilderInterface

RouteBuilderInterface

interface RouteBuilderInterface (View source)

Rebuilds the route information and dumps it.

Rebuilding the route information is the process of gathering all routing data from .routing.yml files, creating a \Symfony\Component\Routing\RouteCollection object out of it, and dispatching that object as a \Drupal\Core\Routing\RouteBuildEvent to all registered listeners. After that, the \Symfony\Component\Routing\RouteCollection object is used to dump the data. Examples of a dump include filling up the routing table, auto-generating Apache mod_rewrite rules, or auto-generating a PHP matcher class.

Methods

bool
rebuild()

Rebuilds the route information and dumps it.

bool
rebuildIfNeeded()

Rebuilds the route information if necessary, and dumps it.

setRebuildNeeded()

Sets the router to be rebuilt next time rebuildIfNeeded() is called.

Details

at line 30
bool rebuild()

Rebuilds the route information and dumps it.

Return Value

bool

Returns TRUE if the rebuild succeeds, FALSE otherwise.

at line 38
bool rebuildIfNeeded()

Rebuilds the route information if necessary, and dumps it.

Return Value

bool

Returns TRUE if the rebuild occurs, FALSE otherwise.

at line 43
setRebuildNeeded()

Sets the router to be rebuilt next time rebuildIfNeeded() is called.