TraceableEventDispatcherInterface
extends
EventDispatcherInterface, ResetInterface
in
The EventDispatcherInterface is the central point of Symfony's event listener system.
since Symfony 4.1
Tags
Table of Contents
Methods
- addListener() : mixed
- Adds an event listener that listens on the specified events.
- addSubscriber() : mixed
- Adds an event subscriber.
- dispatch() : object
- Dispatches an event to all registered listeners.
- getCalledListeners() : array<string|int, mixed>
- Gets the called listeners.
- getListenerPriority() : int|null
- Gets the listener priority for a specific event.
- getListeners() : array<string|int, mixed>
- Gets the listeners of a specific event or all listeners sorted by descending priority.
- getNotCalledListeners() : array<string|int, mixed>
- Gets the not called listeners.
- hasListeners() : bool
- Checks whether an event has any registered listeners.
- removeListener() : mixed
- Removes an event listener from the specified events.
- removeSubscriber() : mixed
- reset() : mixed
Methods
addListener()
Adds an event listener that listens on the specified events.
public
addListener(string $eventName, callable $listener[, int $priority = 0 ]) : mixed
Parameters
- $eventName : string
-
The event to listen on
- $listener : callable
-
The listener
- $priority : int = 0
-
The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
addSubscriber()
Adds an event subscriber.
public
addSubscriber(EventSubscriberInterface $subscriber) : mixed
The subscriber is asked for all the events it is interested in and added as a listener for these events.
Parameters
- $subscriber : EventSubscriberInterface
dispatch()
Dispatches an event to all registered listeners.
public
dispatch(object $event) : object
For BC with Symfony 4, the $eventName argument is not declared explicitly on the signature of the method. Implementations that are not bound by this BC constraint MUST declare it explicitly, as allowed by PHP.
Parameters
- $event : object
-
The event to pass to the event handlers/listeners
Return values
object —The passed $event MUST be returned
getCalledListeners()
Gets the called listeners.
public
getCalledListeners() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of called listeners
getListenerPriority()
Gets the listener priority for a specific event.
public
getListenerPriority(string $eventName, callable $listener) : int|null
Returns null if the event or the listener does not exist.
Parameters
- $eventName : string
-
The name of the event
- $listener : callable
-
The listener
Return values
int|null —The event listener priority
getListeners()
Gets the listeners of a specific event or all listeners sorted by descending priority.
public
getListeners([string|null $eventName = null ]) : array<string|int, mixed>
Parameters
- $eventName : string|null = null
-
The name of the event
Return values
array<string|int, mixed> —The event listeners for the specified event, or all event listeners by event name
getNotCalledListeners()
Gets the not called listeners.
public
getNotCalledListeners() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of not called listeners
hasListeners()
Checks whether an event has any registered listeners.
public
hasListeners([string|null $eventName = null ]) : bool
Parameters
- $eventName : string|null = null
-
The name of the event
Return values
bool —true if the specified event has any listeners, false otherwise
removeListener()
Removes an event listener from the specified events.
public
removeListener(string $eventName, callable $listener) : mixed
Parameters
- $eventName : string
-
The event to remove a listener from
- $listener : callable
-
The listener to remove
removeSubscriber()
public
removeSubscriber(EventSubscriberInterface $subscriber) : mixed
Parameters
- $subscriber : EventSubscriberInterface
reset()
public
reset() : mixed