Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe ListenersPriorityQueue
+ Graphe d'héritage de ListenersPriorityQueue:

Fonctions membres publiques

 __construct ()
 
 add ($listener, $priority)
 
 remove ($listener)
 
 has ($listener)
 
 getPriority ($listener, $default=null)
 
 getAll ()
 
 getIterator ()
 
 count ()
 

Attributs protégés

 $queue
 
 $storage
 

Attributs privés

 $counter = PHP_INT_MAX
 

Description détaillée

A class containing an inner listeners priority queue that can be iterated multiple times. One instance of ListenersPriorityQueue is used per Event in the Dispatcher.

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor.

Depuis
1.0

Documentation des fonctions membres

◆ add()

add (   $listener,
  $priority 
)

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

Paramètres
\Closure | object$listenerThe listener.
integer$priorityThe listener priority.
Renvoie
ListenersPriorityQueue This method is chainable.
Depuis
1.0

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

◆ getAll()

getAll ( )

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

Renvoie
object[] An array of listeners.
Depuis
1.0

Références ListenersPriorityQueue\$queue, et ListenersPriorityQueue\getIterator().

◆ getIterator()

getIterator ( )

Get the inner queue with its cursor on top of the heap.

Renvoie
SplPriorityQueue The inner queue.
Depuis
1.0

Références ListenersPriorityQueue\$queue.

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

◆ getPriority()

getPriority (   $listener,
  $default = null 
)

Get the priority of the given listener.

Paramètres
\Closure | object$listenerThe listener.
mixed$defaultThe default value to return if the listener doesn't exist.
Renvoie
mixed The listener priority if it exists, null otherwise.
Depuis
1.0

Références $default.

◆ has()

has (   $listener)

Tell if the listener exists in the queue.

Paramètres
\Closure | object$listenerThe listener.
Renvoie
boolean True if it exists, false otherwise.
Depuis
1.0

◆ remove()

remove (   $listener)

Remove a listener from the queue.

Paramètres
\Closure | object$listenerThe listener.
Renvoie
ListenersPriorityQueue This method is chainable.
Depuis
1.0

Documentation des champs

◆ $counter

$counter = PHP_INT_MAX
private

◆ $queue

◆ $storage

$storage
protected

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