RouteBuildEvent.php

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

Namespace

Drupal\Core\Routing

File

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

View source
<?php

namespace Drupal\Core\Routing;

use Drupal\Component\EventDispatcher\Event;
use Symfony\Component\Routing\RouteCollection;

/**
 * Represents route building information as event.
 */
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;
    }

}

Classes

Title Deprecated Summary
RouteBuildEvent Represents route building information as event.

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