class RouteBuildEvent

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/RouteBuildEvent.php \Drupal\Core\Routing\RouteBuildEvent
  2. 10 core/lib/Drupal/Core/Routing/RouteBuildEvent.php \Drupal\Core\Routing\RouteBuildEvent
  3. 11.x core/lib/Drupal/Core/Routing/RouteBuildEvent.php \Drupal\Core\Routing\RouteBuildEvent

Represents route building information as event.

Hierarchy

  • class \Drupal\Component\EventDispatcher\Event extends \Symfony\Component\EventDispatcher\Event
    • class \Drupal\Core\Routing\RouteBuildEvent extends \Drupal\Component\EventDispatcher\Event

Expanded class hierarchy of RouteBuildEvent

19 files declare their use of RouteBuildEvent
AdminRouteSubscriberTest.php in core/modules/system/tests/src/Unit/Routing/AdminRouteSubscriberTest.php
ContentModerationRouteSubscriberTest.php in core/modules/content_moderation/tests/src/Unit/ContentModerationRouteSubscriberTest.php
EntityResourcePostRouteSubscriber.php in core/modules/rest/src/EventSubscriber/EntityResourcePostRouteSubscriber.php
EntityRouteAlterSubscriber.php in core/lib/Drupal/Core/EventSubscriber/EntityRouteAlterSubscriber.php
EntityRouteProviderSubscriber.php in core/lib/Drupal/Core/EventSubscriber/EntityRouteProviderSubscriber.php

... See full list

File

core/lib/Drupal/Core/Routing/RouteBuildEvent.php, line 11

Namespace

Drupal\Core\Routing
View source 
class RouteBuildEvent extends Event {
    
    /**
     * The route collection.
     *
     * @var \Symfony\Component\Routing\RouteCollection
     */
    protected $routeCollection;
    
    /**
     * Constructs a RouteBuildEvent object.
     *
     * @param \Symfony\Component\Routing\RouteCollection $route_collection
     *   The route collection.
     */
    public function __construct(RouteCollection $route_collection) {
        $this->routeCollection = $route_collection;
    }
    
    /**
     * Gets the route collection.
     */
    public function getRouteCollection() {
        return $this->routeCollection;
    }

}

Members

Title Modifiers Object type Summary
RouteBuildEvent::$routeCollection protected property The route collection.
RouteBuildEvent::getRouteCollection public function Gets the route collection.
RouteBuildEvent::__construct public function Constructs a RouteBuildEvent object.

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