Issue #2533220 by snehi, pjonckiere, mirom, chx, jhodgdon, dawehner: RouteBuilderInterface has no docblock
parent
49f8560c96
commit
15b999d16b
|
@ -2,10 +2,27 @@
|
|||
|
||||
namespace Drupal\Core\Routing;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @see \Drupal\Core\Routing\MatcherDumperInterface
|
||||
* @see \Drupal\Core\Routing\RouteProviderInterface
|
||||
*
|
||||
* @ingroup routing
|
||||
*/
|
||||
interface RouteBuilderInterface {
|
||||
|
||||
/**
|
||||
* Rebuilds the route info and dumps to dumper.
|
||||
* Rebuilds the route information and dumps it.
|
||||
*
|
||||
* @return bool
|
||||
* Returns TRUE if the rebuild succeeds, FALSE otherwise.
|
||||
|
@ -13,7 +30,7 @@ interface RouteBuilderInterface {
|
|||
public function rebuild();
|
||||
|
||||
/**
|
||||
* Rebuilds the route info and dumps to dumper if necessary.
|
||||
* Rebuilds the route information if necessary, and dumps it.
|
||||
*
|
||||
* @return bool
|
||||
* Returns TRUE if the rebuild occurs, FALSE otherwise.
|
||||
|
|
Loading…
Reference in New Issue