annotate core/lib/Drupal/Core/Routing/RouteSubscriberBase.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Routing;
Chris@0 4
Chris@0 5 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Chris@0 6 use Symfony\Component\Routing\RouteCollection;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Provides a base implementation for RouteSubscriber.
Chris@0 10 */
Chris@0 11 abstract class RouteSubscriberBase implements EventSubscriberInterface {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Alters existing routes for a specific collection.
Chris@0 15 *
Chris@0 16 * @param \Symfony\Component\Routing\RouteCollection $collection
Chris@0 17 * The route collection for adding routes.
Chris@0 18 */
Chris@0 19 abstract protected function alterRoutes(RouteCollection $collection);
Chris@0 20
Chris@0 21 /**
Chris@0 22 * {@inheritdoc}
Chris@0 23 */
Chris@0 24 public static function getSubscribedEvents() {
Chris@0 25 $events[RoutingEvents::ALTER] = 'onAlterRoutes';
Chris@0 26 return $events;
Chris@0 27 }
Chris@0 28
Chris@0 29 /**
Chris@0 30 * Delegates the route altering to self::alterRoutes().
Chris@0 31 *
Chris@0 32 * @param \Drupal\Core\Routing\RouteBuildEvent $event
Chris@0 33 * The route build event.
Chris@0 34 */
Chris@0 35 public function onAlterRoutes(RouteBuildEvent $event) {
Chris@0 36 $collection = $event->getRouteCollection();
Chris@0 37 $this->alterRoutes($collection);
Chris@0 38 }
Chris@0 39
Chris@0 40 }