Référence de la classe Dispatcher

Graphe d'héritage de Dispatcher:

Fonctions membres publiques
	setEvent (EventInterface $event)
	addEvent (EventInterface $event)
	hasEvent ($event)
	getEvent ($name, $default=null)
	removeEvent ($event)
	getEvents ()
	clearEvents ()
	countEvents ()
	addListener (string $eventName, callable $callback, int $priority=0)
	getListenerPriority ($eventName, callable $callback)
	getListeners (?string $event=null)
	hasListener (callable $callback, ?string $eventName=null)
	removeListener (string $eventName, callable $listener)
	clearListeners ($event=null)
	countListeners ($event)
	addSubscriber (SubscriberInterface $subscriber)
	removeSubscriber (SubscriberInterface $subscriber)
	dispatch (string $name, ?EventInterface $event=null)
	triggerEvent ($event)

Attributs protégés
	$events = []
	$listeners = []

Fonctions membres privées
	getDefaultEvent (string $name)

Description détaillée

Implementation of a DispatcherInterface supporting prioritized listeners.

Depuis

1.0

Documentation des fonctions membres

addEvent()

addEvent

(

EventInterface

$event

)

Add an event to this dispatcher, only if it is not existing.

Paramètres

EventInterface

$event

The event.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références $this, et EventInterface\getName().

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

1.0

Implémente DispatcherInterface.

Références ListenersPriorityQueue\add().

Référencé par Dispatcher\addSubscriber().

addSubscriber()

addSubscriber

(

SubscriberInterface

$subscriber

)

Adds an event subscriber.

Paramètres

SubscriberInterface

$subscriber

The subscriber.

Renvoie

void

Depuis

2.0.0

Implémente DispatcherInterface.

Références $params, Dispatcher\addListener(), SubscriberInterface\getSubscribedEvents(), et Priority\NORMAL.

clearEvents()

clearEvents

(

)

Clear all events.

Renvoie

EventInterface[] The old events.

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références Dispatcher\$events.

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

1.0

Implémente DispatcherInterface.

Références $this.

countEvents()

countEvents

(

)

Count the number of registered event.

Renvoie

integer The numer of registered events.

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

countListeners()

countListeners

(

$event

)

Count the number of registered listeners for the given event.

Paramètres

string

$event

The event name.

Renvoie

integer

Depuis

1.0

Implémente DispatcherInterface.

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émente DispatcherInterface.

Références Dispatcher\getDefaultEvent().

Référencé par Dispatcher\triggerEvent().

getDefaultEvent()

getDefaultEvent ( string  $name )

private

Get an event object for the specified event name

Paramètres

string

$name

The event name to get an EventInterface object for

Renvoie

EventInterface

Depuis

2.0.0

Obsolète:

3.0 Default event objects will no longer be supported

Références $name.

Référencé par Dispatcher\dispatch(), et Dispatcher\triggerEvent().

getEvent()

getEvent	(		$name,
			$default = null
	)

Get the event object identified by the given name.

Paramètres

string	$name	The event name.
mixed	$default	The default value if the event was not registered.

Renvoie

EventInterface|mixed The event of the default value.

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références $default, et $name.

getEvents()

getEvents

(

)

Get the registered events.

Renvoie

EventInterface[] The registered event.

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références Dispatcher\$events.

getListenerPriority()

getListenerPriority	(		$eventName,
		callable	$callback
	)

Get the priority of the given listener for the given event.

Paramètres

string	$eventName	The event to listen to.
callable	$callback	A callable function

Renvoie

mixed The listener priority or null if the listener doesn't exist.

Depuis

1.0

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

1.0

Implémente DispatcherInterface.

Références Dispatcher\$listeners, et null.

hasEvent()

hasEvent

(

$event

)

Tell if the given event has been added to this dispatcher.

Paramètres

EventInterface | string

$event

The event object or name.

Renvoie

boolean True if the listener has the given event, false otherwise.

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

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	$eventName	An optional event name to check a listener is subscribed to.

Renvoie

boolean True if the listener is registered, false otherwise.

Depuis

1.0

Implémente DispatcherInterface.

removeEvent()

removeEvent

(

$event

)

Remove an event from this dispatcher. The registered listeners will remain.

Paramètres

EventInterface | string

$event

The event object or name.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références $this.

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émente DispatcherInterface.

Référencé par Dispatcher\removeSubscriber().

removeSubscriber()

removeSubscriber

(

SubscriberInterface

$subscriber

)

Removes an event subscriber.

Paramètres

SubscriberInterface

$subscriber

The subscriber.

Renvoie

void

Depuis

2.0.0

Implémente DispatcherInterface.

Références $params, SubscriberInterface\getSubscribedEvents(), et Dispatcher\removeListener().

setEvent()

setEvent

(

EventInterface

$event

)

Set an event to the dispatcher. It will replace any event with the same name.

Paramètres

EventInterface

$event

The event.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Default event objects will no longer be supported

Références $this, et EventInterface\getName().

triggerEvent()

triggerEvent

(

$event

)

Trigger an event.

Paramètres

EventInterface | string

$event

The event object or name.

Renvoie

EventInterface The event after being passed through all listeners.

Depuis

1.0

Obsolète:

3.0 Use dispatch() instead.

Références class, Dispatcher\dispatch(), et Dispatcher\getDefaultEvent().

Documentation des champs

$events

$events = []

protected

Référencé par Dispatcher\clearEvents(), et Dispatcher\getEvents().

$listeners

$listeners = []

protected

Référencé par Dispatcher\getListeners().

---

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

• libraries/vendor/joomla/event/src/Dispatcher.php