class RouteBuildEvent in Zircon Profile 8

Represents route building information as event.

Hierarchy

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

13 files declare their use of RouteBuildEvent

EntityRouteAlterSubscriber.php in core/lib/Drupal/Core/EventSubscriber/EntityRouteAlterSubscriber.php

Contains \Drupal\Core\EventSubscriber\EntityRouteAlterSubscriber.

EntityRouteProviderSubscriber.php in core/lib/Drupal/Core/EventSubscriber/EntityRouteProviderSubscriber.php

Contains \Drupal\Core\EventSubscriber\EntityRouteProviderSubscriber.

ModuleRouteSubscriberTest.php in core/tests/Drupal/Tests/Core/EventSubscriber/ModuleRouteSubscriberTest.php

Contains \Drupal\Tests\Core\EventSubscriber\ModuleRouteSubscriberTest.

ParamConverterSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ParamConverterSubscriber.php

Contains \Drupal\Core\EventSubscriber\ParamConverterSubscriber.

PathRootsSubscriber.php in core/lib/Drupal/Core/EventSubscriber/PathRootsSubscriber.php

Contains \Drupal\Core\EventSubscriber\PathRootsSubscriber.

... See full list

File

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

Contains \Drupal\Core\Routing\RouteBuildEvent.

Namespace

Drupal\Core\Routing

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

Name	Modifiers	Type	Description	Overrides
Event::$dispatcher	private	property
Event::$name	private	property
Event::$propagationStopped	private	property
Event::getDispatcher Deprecated	public	function	Returns the EventDispatcher that dispatches this Event.
Event::getName Deprecated	public	function	Gets the event's name.
Event::isPropagationStopped	public	function	Returns whether further event listeners should be triggered.
Event::setDispatcher Deprecated	public	function	Stores the EventDispatcher that dispatches this Event.
Event::setName Deprecated	public	function	Sets the event's name property.
Event::stopPropagation	public	function	Stops the propagation of the event to further event listeners.
RouteBuildEvent::$routeCollection	protected	property	The route collection.
RouteBuildEvent::getRouteCollection	public	function	Gets the route collection.
RouteBuildEvent::__construct	public	function	Constructs a RouteBuildEvent object.