RouteSubscriberBase.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/RouteSubscriberBase.php
  2. 10 core/lib/Drupal/Core/Routing/RouteSubscriberBase.php
  3. 11.x core/lib/Drupal/Core/Routing/RouteSubscriberBase.php

Namespace

Drupal\Core\Routing

File

core/lib/Drupal/Core/Routing/RouteSubscriberBase.php

View source
<?php

namespace Drupal\Core\Routing;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Routing\RouteCollection;

/**
 * Provides a base implementation for RouteSubscriber.
 */
abstract class RouteSubscriberBase implements EventSubscriberInterface {
    
    /**
     * Alters existing routes for a specific collection.
     *
     * @param \Symfony\Component\Routing\RouteCollection $collection
     *   The route collection for adding routes.
     */
    protected abstract function alterRoutes(RouteCollection $collection);
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() {
        $events[RoutingEvents::ALTER] = 'onAlterRoutes';
        return $events;
    }
    
    /**
     * Delegates the route altering to self::alterRoutes().
     *
     * @param \Drupal\Core\Routing\RouteBuildEvent $event
     *   The route build event.
     */
    public function onAlterRoutes(RouteBuildEvent $event) {
        $collection = $event->getRouteCollection();
        $this->alterRoutes($collection);
    }

}

Classes

Title Deprecated Summary
RouteSubscriberBase Provides a base implementation for RouteSubscriber.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.