1. class
  2. Symfony
  3. Component
  4. EventDispatcher
  5. ImmutableEventDispatcher

ImmutableEventDispatcher

class ImmutableEventDispatcher implements EventDispatcherInterface

A read-only proxy for an event dispatcher.

Methods

__construct(EventDispatcherInterface $dispatcher)

Creates an unmodifiable proxy for an event dispatcher.

Event
dispatch(string $eventName, Event $event = null)

Dispatches an event to all registered listeners.

addListener(string $eventName, callable $listener, int $priority)

Adds an event listener that listens on the specified events.

addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.

removeListener(string $eventName, callable $listener)

Removes an event listener from the specified events.

removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

array
getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners sorted by descending priority.

getListenerPriority($eventName, $listener)

{@inheritdoc}

bool
hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

Details

at line line 33
__construct(EventDispatcherInterface $dispatcher)

Creates an unmodifiable proxy for an event dispatcher.

Parameters

EventDispatcherInterface $dispatcher The proxied event dispatcher.

at line line 41
Event dispatch(string $eventName, Event $event = null)

Dispatches an event to all registered listeners.

Parameters

string $eventName 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 The event to pass to the event handlers/listeners. If not supplied, an empty Event instance is created.

Return Value

Event

at line line 49
addListener(string $eventName, callable $listener, int $priority)

Adds an event listener that listens on the specified events.

Parameters

string $eventName The event to listen on
callable $listener The listener
int $priority The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

at line line 57
addSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber.

The subscriber is asked for all the events he is interested in and added as a listener for these events.

Parameters

EventSubscriberInterface $subscriber The subscriber.

at line line 65
removeListener(string $eventName, callable $listener)

Removes an event listener from the specified events.

Parameters

string $eventName The event to remove a listener from
callable $listener The listener to remove

at line line 73
removeSubscriber(EventSubscriberInterface $subscriber)

Removes an event subscriber.

Parameters

EventSubscriberInterface $subscriber The subscriber

at line line 81
array getListeners(string $eventName = null)

Gets the listeners of a specific event or all listeners sorted by descending priority.

Parameters

string $eventName The name of the event

Return Value

array The event listeners for the specified event, or all event listeners by event name

at line line 89
getListenerPriority($eventName, $listener)

{@inheritdoc}

Parameters

$eventName
$listener

at line line 97
bool hasListeners(string $eventName = null)

Checks whether an event has any registered listeners.

Parameters

string $eventName The name of the event

Return Value

bool true if the specified event has any listeners, false otherwise