blob: d191cb9a6c81664846ec7df4e81687401363e8cc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
<?php
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 information and dumps it.
*
* @return bool
* Returns TRUE if the rebuild succeeds, FALSE otherwise.
*/
public function rebuild();
/**
* Rebuilds the route information if necessary, and dumps it.
*
* @return bool
* Returns TRUE if the rebuild occurs, FALSE otherwise.
*/
public function rebuildIfNeeded();
/**
* Sets the router to be rebuilt next time rebuildIfNeeded() is called.
*/
public function setRebuildNeeded();
}
|
