ImmutableEventDispatcher
in package
implements
EventDispatcherInterface
A read-only proxy for an event dispatcher.
Tags
Table of Contents
Interfaces
- EventDispatcherInterface
- The EventDispatcherInterface is the central point of Symfony's event listener system.
Properties
- $dispatcher : EventDispatcherInterface
- The proxied dispatcher.
Methods
- __construct() : mixed
- Creates an unmodifiable proxy for an event dispatcher.
- addListener() : mixed
- Adds an event listener that listens on the specified events.
- addSubscriber() : mixed
- Adds an event subscriber.
- dispatch() : Event
- Dispatches an event to all registered listeners.
- getListenerPriority() : mixed
- {@inheritdoc}
- getListeners() : array<string|int, mixed>
- Gets the listeners of a specific event or all listeners sorted by descending priority.
- hasListeners() : bool
- Checks whether an event has any registered listeners.
- removeListener() : mixed
- Removes an event listener from the specified events.
- removeSubscriber() : mixed
- Removes an event subscriber.
Properties
$dispatcher
The proxied dispatcher.
private
EventDispatcherInterface
$dispatcher
Methods
__construct()
Creates an unmodifiable proxy for an event dispatcher.
public
__construct(EventDispatcherInterface $dispatcher) : mixed
Parameters
- $dispatcher : EventDispatcherInterface
-
The proxied event dispatcher.
addListener()
Adds an event listener that listens on the specified events.
public
addListener(mixed $eventName, mixed $listener[, mixed $priority = 0 ]) : mixed
Parameters
- $eventName : mixed
-
The event to listen on
- $listener : mixed
-
The listener
- $priority : mixed = 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
Parameters
- $subscriber : EventSubscriberInterface
-
The subscriber.
dispatch()
Dispatches an event to all registered listeners.
public
dispatch(mixed $eventName[, Event $event = null ]) : Event
Parameters
- $eventName : mixed
-
The name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.
- $event : Event = null
-
The event to pass to the event handlers/listeners. If not supplied, an empty Event instance is created.
Return values
EventgetListenerPriority()
{@inheritdoc}
public
getListenerPriority(mixed $eventName, mixed $listener) : mixed
Parameters
- $eventName : mixed
- $listener : mixed
getListeners()
Gets the listeners of a specific event or all listeners sorted by descending priority.
public
getListeners([mixed $eventName = null ]) : array<string|int, mixed>
Parameters
- $eventName : mixed = 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
hasListeners()
Checks whether an event has any registered listeners.
public
hasListeners([mixed $eventName = null ]) : bool
Parameters
- $eventName : mixed = 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(mixed $eventName, mixed $listener) : mixed
Parameters
- $eventName : mixed
-
The event to remove a listener from
- $listener : mixed
-
The listener to remove
removeSubscriber()
Removes an event subscriber.
public
removeSubscriber(EventSubscriberInterface $subscriber) : mixed
Parameters
- $subscriber : EventSubscriberInterface
-
The subscriber