W3cubDocs

/Drupal 8

interface RouteBuilderInterface

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.

Hierarchy

See also

\Drupal\Core\Routing\MatcherDumperInterface

\Drupal\Core\Routing\RouteProviderInterface

Related topics

Routing API
Route page requests to code based on URLs.

File

core/lib/Drupal/Core/Routing/RouteBuilderInterface.php, line 22

Namespace

Drupal\Core\Routing

Members

Name Modifiers Type Description
RouteBuilderInterface::rebuild public function Rebuilds the route information and dumps it.
RouteBuilderInterface::rebuildIfNeeded public function Rebuilds the route information if necessary, and dumps it.
RouteBuilderInterface::setRebuildNeeded public function Sets the router to be rebuilt next time rebuildIfNeeded() is called.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Routing!RouteBuilderInterface.php/interface/RouteBuilderInterface/8.1.x