\Symfony\Component\EventDispatcherEventDispatcherInterface

The EventDispatcherInterface is the central point of Symfony's event listener system.

Listeners are registered on the manager and events are dispatched through the manager.

Summary

Methods

Constants

dispatch()
addListener()
addSubscriber()
removeListener()
removeSubscriber()
getListeners()
hasListeners()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: vendor/symfony/event-dispatcher/EventDispatcherInterface.php
Package: \Default

Methods

dispatch()

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

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

Returns

\Symfony\Component\EventDispatcher\Event

addListener()

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

Adds an event listener that listens on the specified events.

Parameters

string	$eventName	The event to listen on
callable	$listener	The listener
integer	$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 he is interested in and added as a listener for these events.

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface

$subscriber

removeListener()

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

removeSubscriber()

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

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface

$subscriber

getListeners()

getListeners(string  $eventName = null) : array

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

Parameters

string

$eventName

The name of the event

Returns

array —

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

hasListeners()

hasListeners(string  $eventName = null) : boolean

Checks whether an event has any registered listeners.

Parameters

string

$eventName

The name of the event

Returns

boolean —

true if the specified event has any listeners, false otherwise