Référence de la classe ListenersPriorityQueue

Graphe d'héritage de ListenersPriorityQueue:

Fonctions membres publiques
	add (callable $callback, int $priority)
	remove (callable $callback)
	has (callable $callback)
	getPriority (callable $callback, $default=null)
	getAll ()
	getIterator ()
	count ()

Attributs privés
	$listeners = []

Description détaillée

A class containing an inner listeners priority queue that can be iterated multiple times.

Depuis

1.0

Documentation des fonctions membres

add()

add	(	callable	$callback,
		int	$priority
	)

Add a listener with the given priority only if not already present.

Paramètres

callable	$callback	A callable function acting as an event listener.
integer	$priority	The listener priority.

Renvoie

$this

Depuis

1.0

Références $this.

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

count()

count

(

)

Count the number of listeners in the queue.

Renvoie

integer The number of listeners in the queue.

Depuis

1.0

Références $count.

getAll()

getAll

(

)

Get all listeners contained in this queue, sorted according to their priority.

Renvoie

callable[] An array of listeners.

Depuis

1.0

Référencé par ListenersPriorityQueue\getIterator().

getIterator()

getIterator

(

)

Get the priority queue.

Renvoie

Depuis

1.0

Références ListenersPriorityQueue\getAll().

getPriority()

getPriority	(	callable	$callback,
			$default = null
	)

Get the priority of the given listener.

Paramètres

callable	$callback	A callable function acting as an event listener.
mixed	$default	The default value to return if the listener doesn't exist.

Renvoie

mixed The listener priority if it exists or the specified default value

Depuis

1.0

Références $default, $key, et ListenersPriorityQueue\$listeners.

has()

has

(

callable

$callback

)

Tell if the listener exists in the queue.

Paramètres

callable

$callback

A callable function acting as an event listener.

Renvoie

boolean True if it exists, false otherwise.

Depuis

1.0

Références $key, et ListenersPriorityQueue\$listeners.

remove()

remove

(

callable

$callback

)

Remove a listener from the queue.

Paramètres

callable

$callback

A callable function acting as an event listener.

Renvoie

$this

Depuis

1.0

Références $key, ListenersPriorityQueue\$listeners, et $this.

Documentation des champs

$listeners

$listeners = []

private

Référencé par ListenersPriorityQueue\getPriority(), ListenersPriorityQueue\has(), et ListenersPriorityQueue\remove().

---

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

• ListenersPriorityQueue.php