Référence de l'interface DispatcherInterface

Graphe d'héritage de DispatcherInterface:

Fonctions membres publiques
	dispatch (string $name, ?EventInterface $event=null)
	addListener (string $eventName, callable $callback, int $priority=0)
	clearListeners ($event=null)
	countListeners ($event)
	getListeners (?string $event=null)
	hasListener (callable $callback, ?string $eventName=null)
	removeListener (string $eventName, callable $listener)
	addSubscriber (SubscriberInterface $subscriber)
	removeSubscriber (SubscriberInterface $subscriber)

Description détaillée

Interface for event dispatchers.

Depuis

1.0

Documentation des fonctions membres

addListener()

addListener	(	string	$eventName,
		callable	$callback,
		int	$priority = 0
	)

Attaches a listener to an event

Paramètres

string	$eventName	The event to listen to.
callable	$callback	A callable function.
integer	$priority	The priority at which the $callback executed.

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Dispatcher.

Référencé par Session\buildSession().

addSubscriber()

addSubscriber

(

SubscriberInterface

$subscriber

)

Adds an event subscriber.

Paramètres

SubscriberInterface

$subscriber

The subscriber.

Renvoie

void

Depuis

2.0.0

Implémenté dans Dispatcher.

clearListeners()

clearListeners

(

$event = null

)

Clear the listeners in this dispatcher.

If an event is specified, the listeners will be cleared only for that event.

Paramètres

string

$event

The event name.

Renvoie

$this

Depuis

2.0.0

Implémenté dans Dispatcher.

countListeners()

countListeners

(

$event

)

Count the number of registered listeners for the given event.

Paramètres

string

$event

The event name.

Renvoie

integer

Depuis

2.0.0

Implémenté dans Dispatcher.

dispatch()

dispatch	(	string	$name,
		?EventInterface	$event = null
	)

Dispatches an event to all registered listeners.

Paramètres

string	$name	The name of the event to dispatch.
EventInterface	$event	The event to pass to the event handlers/listeners. If not supplied, an empty EventInterface instance is created. Note, not passing an event is deprecated and will be required as of 3.0.

Renvoie

EventInterface

Depuis

2.0.0

Implémenté dans Dispatcher.

getListeners()

getListeners

(

?string

$event = null

)

Get the listeners registered to the given event.

Paramètres

string | null

$event

The event to fetch listeners for or null to fetch all listeners

Renvoie

callable[] An array of registered listeners sorted according to their priorities.

Depuis

2.0.0

Implémenté dans Dispatcher.

hasListener()

hasListener	(	callable	$callback,
		?string	$eventName = null
	)

Tell if the given listener has been added.

If an event is specified, it will tell if the listener is registered for that event.

Paramètres

callable	$callback	The callable to check is listening to the event.
string | null	$eventName	An optional event name to check a listener is subscribed to.

Renvoie

boolean True if the listener is registered, false otherwise.

Depuis

2.0.0

Implémenté dans Dispatcher.

removeListener()

removeListener	(	string	$eventName,
		callable	$listener
	)

Removes an event listener from the specified event.

Paramètres

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

Renvoie

void

Depuis

2.0.0

Implémenté dans Dispatcher.

removeSubscriber()

removeSubscriber

(

SubscriberInterface

$subscriber

)

Removes an event subscriber.

Paramètres

SubscriberInterface

$subscriber

The subscriber.

Renvoie

void

Depuis

2.0.0

Implémenté dans Dispatcher.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• vendor/joomla/event/src/DispatcherInterface.php