\Symfony\Component\EventDispatcherImmutableEventDispatcher

A read-only proxy for an event dispatcher.

Summary

Methods
Properties
Constants
__construct()
dispatch()
addListener()
addSubscriber()
removeListener()
removeSubscriber()
getListeners()
getListenerPriority()
hasListeners()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$dispatcher
N/A

Properties

$dispatcher

$dispatcher : 

Type

Methods

dispatch()

dispatch(\Symfony\Component\EventDispatcher\object  $event, \Symfony\Component\EventDispatcher\string  $eventName = null) 

{@inheritdoc}

Parameters

\Symfony\Component\EventDispatcher\object $event
\Symfony\Component\EventDispatcher\string $eventName

addListener()

addListener(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener, \Symfony\Component\EventDispatcher\int  $priority) 

Adds an event listener that listens on the specified events.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener

\Symfony\Component\EventDispatcher\int $priority

The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)

addSubscriber()

addSubscriber(\Symfony\Component\EventDispatcher\EventSubscriberInterface  $subscriber) 

Adds an event subscriber.

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

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber

removeListener()

removeListener(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener) 

Removes an event listener from the specified events.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener to remove

getListeners()

getListeners(\Symfony\Component\EventDispatcher\string  $eventName = null) : array

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

Parameters

\Symfony\Component\EventDispatcher\string $eventName

Returns

array —

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

getListenerPriority()

getListenerPriority(\Symfony\Component\EventDispatcher\string  $eventName, callable  $listener) : integer|null

Gets the listener priority for a specific event.

Returns null if the event or the listener does not exist.

Parameters

\Symfony\Component\EventDispatcher\string $eventName
callable $listener

The listener

Returns

integer|null —

The event listener priority

hasListeners()

hasListeners(\Symfony\Component\EventDispatcher\string  $eventName = null) : boolean

Checks whether an event has any registered listeners.

Parameters

\Symfony\Component\EventDispatcher\string $eventName

Returns

boolean —

true if the specified event has any listeners, false otherwise