\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()
getListenerPriority()
hasListeners()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: vendor/symfony/event-dispatcher/EventDispatcherInterface.php
Package: \Application
Parents: \Symfony\Contracts\EventDispatcher\EventDispatcherInterface

Methods

dispatch()

dispatch(object  $event) : object

Provide all relevant listeners with an event to process.

Parameters

object

$event

The object to process.

Returns

object —

The Event that was passed, now modified by listeners.

addListener()

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

Adds an event listener that listens on the specified events.

Parameters

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

Returns

mixed —

addSubscriber()

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

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

Returns

mixed —

removeListener()

removeListener(string  $eventName, callable  $listener) : mixed

Removes an event listener from the specified events.

Parameters

string	$eventName
callable	$listener

Returns

mixed —

removeSubscriber()

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

Parameters

\Symfony\Component\EventDispatcher\EventSubscriberInterface

$subscriber

Returns

mixed —

getListeners()

getListeners(string  $eventName = null) : (callable[]|callable)[]

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

Parameters

string

$eventName

Returns

(callable[]|callable)[] —

getListenerPriority()

getListenerPriority(string  $eventName, callable  $listener) : int|null

Gets the listener priority for a specific event.

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

Parameters

string	$eventName
callable	$listener

Returns

int|null —

hasListeners()

hasListeners(string  $eventName = null) : bool

Checks whether an event has any registered listeners.

Parameters

string

$eventName

Returns

bool —