Represents route building information as event.
Expanded class hierarchy of RouteBuildEvent
class RouteBuildEvent extends Event {
/**
* The route collection.
*
* @var \Symfony\Component\Routing\RouteCollection
*/
protected $routeCollection;
/**
* The module name that provides the route.
*
* @var string
*/
protected $module;
/**
* Constructs a RouteBuildEvent object.
*/
public function __construct(RouteCollection $route_collection, $module) {
$this->routeCollection = $route_collection;
$this->module = $module;
}
/**
* Gets the route collection.
*/
public function getRouteCollection() {
return $this->routeCollection;
}
/**
* Gets the module that provides the route.
*/
public function getModule() {
return $this->module;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Event:: |
private | property | ||
Event:: |
private | property | ||
Event:: |
private | property | ||
Event:: |
public | function | Returns the EventDispatcher that dispatches this Event | |
Event:: |
public | function | Gets the event's name. | |
Event:: |
public | function | Returns whether further event listeners should be triggered. | |
Event:: |
public | function | Stores the EventDispatcher that dispatches this Event | |
Event:: |
public | function | Sets the event's name property. | |
Event:: |
public | function | Stops the propagation of the event to further event listeners. | |
RouteBuildEvent:: |
protected | property | The module name that provides the route. | |
RouteBuildEvent:: |
protected | property | The route collection. | |
RouteBuildEvent:: |
public | function | Gets the module that provides the route. | |
RouteBuildEvent:: |
public | function | Gets the route collection. | |
RouteBuildEvent:: |
public | function | Constructs a RouteBuildEvent object. |