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

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