Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\Core\Routing;
|
Chris@0
|
4
|
Chris@0
|
5 /**
|
Chris@0
|
6 * Contains all events thrown in the core routing component.
|
Chris@0
|
7 */
|
Chris@0
|
8 final class RoutingEvents {
|
Chris@0
|
9
|
Chris@0
|
10 /**
|
Chris@0
|
11 * Name of the event fired during route collection to allow new routes.
|
Chris@0
|
12 *
|
Chris@0
|
13 * This event is used to add new routes based upon existing routes, giving
|
Chris@0
|
14 * modules the opportunity to dynamically generate additional routes. The
|
Chris@0
|
15 * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent
|
Chris@0
|
16 * instance.
|
Chris@0
|
17 *
|
Chris@0
|
18 * @Event
|
Chris@0
|
19 *
|
Chris@0
|
20 * @see \Drupal\Core\Routing\RouteBuildEvent
|
Chris@0
|
21 * @see \Drupal\Core\EventSubscriber\EntityRouteProviderSubscriber
|
Chris@0
|
22 * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
|
Chris@0
|
23 *
|
Chris@0
|
24 * @var string
|
Chris@0
|
25 */
|
Chris@0
|
26 const DYNAMIC = 'routing.route_dynamic';
|
Chris@0
|
27
|
Chris@0
|
28 /**
|
Chris@0
|
29 * Name of the event fired during route collection to allow changes to routes.
|
Chris@0
|
30 *
|
Chris@0
|
31 * This event is used to process new routes before they get saved, giving
|
Chris@0
|
32 * modules the opportunity to alter routes provided by any other module. The
|
Chris@0
|
33 * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent
|
Chris@0
|
34 * instance.
|
Chris@0
|
35 *
|
Chris@0
|
36 * @Event
|
Chris@0
|
37 *
|
Chris@0
|
38 * @see \Symfony\Component\Routing\RouteCollection
|
Chris@0
|
39 * @see \Drupal\system\EventSubscriber\AdminRouteSubscriber
|
Chris@0
|
40 * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
|
Chris@0
|
41 *
|
Chris@0
|
42 * @var string
|
Chris@0
|
43 */
|
Chris@0
|
44 const ALTER = 'routing.route_alter';
|
Chris@0
|
45
|
Chris@0
|
46 /**
|
Chris@0
|
47 * Name of the event fired to indicate route building has ended.
|
Chris@0
|
48 *
|
Chris@0
|
49 * This event gives modules the opportunity to perform some action after route
|
Chris@0
|
50 * building has completed. The event listener receives a
|
Chris@0
|
51 * \Symfony\Component\EventDispatcher\Event instance.
|
Chris@0
|
52 *
|
Chris@0
|
53 * @Event
|
Chris@0
|
54 *
|
Chris@0
|
55 * @see \Symfony\Component\EventDispatcher\Event
|
Chris@0
|
56 * @see \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber
|
Chris@0
|
57 * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
|
Chris@0
|
58 *
|
Chris@0
|
59 * @var string
|
Chris@0
|
60 */
|
Chris@0
|
61 const FINISHED = 'routing.route_finished';
|
Chris@0
|
62
|
Chris@0
|
63 }
|