annotate core/lib/Drupal/Core/Routing/RouteBuilderInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Routing;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Rebuilds the route information and dumps it.
Chris@0 7 *
Chris@0 8 * Rebuilding the route information is the process of gathering all routing data
Chris@0 9 * from .routing.yml files, creating a
Chris@0 10 * \Symfony\Component\Routing\RouteCollection object out of it, and dispatching
Chris@0 11 * that object as a \Drupal\Core\Routing\RouteBuildEvent to all registered
Chris@0 12 * listeners. After that, the \Symfony\Component\Routing\RouteCollection object
Chris@0 13 * is used to dump the data. Examples of a dump include filling up the routing
Chris@0 14 * table, auto-generating Apache mod_rewrite rules, or auto-generating a PHP
Chris@0 15 * matcher class.
Chris@0 16 *
Chris@0 17 * @see \Drupal\Core\Routing\MatcherDumperInterface
Chris@0 18 * @see \Drupal\Core\Routing\RouteProviderInterface
Chris@0 19 *
Chris@0 20 * @ingroup routing
Chris@0 21 */
Chris@0 22 interface RouteBuilderInterface {
Chris@0 23
Chris@0 24 /**
Chris@0 25 * Rebuilds the route information and dumps it.
Chris@0 26 *
Chris@0 27 * @return bool
Chris@0 28 * Returns TRUE if the rebuild succeeds, FALSE otherwise.
Chris@0 29 */
Chris@0 30 public function rebuild();
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Rebuilds the route information if necessary, and dumps it.
Chris@0 34 *
Chris@0 35 * @return bool
Chris@0 36 * Returns TRUE if the rebuild occurs, FALSE otherwise.
Chris@0 37 */
Chris@0 38 public function rebuildIfNeeded();
Chris@0 39
Chris@0 40 /**
Chris@0 41 * Sets the router to be rebuilt next time rebuildIfNeeded() is called.
Chris@0 42 */
Chris@0 43 public function setRebuildNeeded();
Chris@0 44
Chris@0 45 }