aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Routing/RouteBuilderInterface.php

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