Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Routing/RoutingEvents.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Routing/RoutingEvents.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,63 @@ +<?php + +namespace Drupal\Core\Routing; + +/** + * Contains all events thrown in the core routing component. + */ +final class RoutingEvents { + + /** + * Name of the event fired during route collection to allow new routes. + * + * This event is used to add new routes based upon existing routes, giving + * modules the opportunity to dynamically generate additional routes. The + * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent + * instance. + * + * @Event + * + * @see \Drupal\Core\Routing\RouteBuildEvent + * @see \Drupal\Core\EventSubscriber\EntityRouteProviderSubscriber + * @see \Drupal\Core\Routing\RouteBuilder::rebuild() + * + * @var string + */ + const DYNAMIC = 'routing.route_dynamic'; + + /** + * Name of the event fired during route collection to allow changes to routes. + * + * This event is used to process new routes before they get saved, giving + * modules the opportunity to alter routes provided by any other module. The + * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent + * instance. + * + * @Event + * + * @see \Symfony\Component\Routing\RouteCollection + * @see \Drupal\system\EventSubscriber\AdminRouteSubscriber + * @see \Drupal\Core\Routing\RouteBuilder::rebuild() + * + * @var string + */ + const ALTER = 'routing.route_alter'; + + /** + * Name of the event fired to indicate route building has ended. + * + * This event gives modules the opportunity to perform some action after route + * building has completed. The event listener receives a + * \Symfony\Component\EventDispatcher\Event instance. + * + * @Event + * + * @see \Symfony\Component\EventDispatcher\Event + * @see \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber + * @see \Drupal\Core\Routing\RouteBuilder::rebuild() + * + * @var string + */ + const FINISHED = 'routing.route_finished'; + +}