1. class
  2. Windwalker
  3. Event
  4. ListenersQueue

ListenersQueue

class ListenersQueue implements IteratorAggregate, Countable (View source)

Class ListenerPriorityQueue

Methods

__construct()

Constructor.

ListenersQueue
add(Closure|object $listener, integer $priority)

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

ListenersQueue
remove(Closure|object $listener)

Remove a listener from the queue.

boolean
has(Closure|object $listener)

Tell if the listener exists in the queue.

mixed
getPriority(Closure|object $listener, mixed $default = null)

Get the priority of the given listener.

object[]
getAll()

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

SplPriorityQueue
getIterator()

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

integer
count()

Count the number of listeners in the queue.

Details

at line line 55
__construct()

Constructor.

at line line 71
ListenersQueue add(Closure|object $listener, integer $priority)

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

Parameters

Closure|object $listener The listener.
integer $priority The listener priority.

Return Value

ListenersQueue This method is chainable.

at line line 94
ListenersQueue remove(Closure|object $listener)

Remove a listener from the queue.

Parameters

Closure|object $listener The listener.

Return Value

ListenersQueue This method is chainable.

at line line 122
boolean has(Closure|object $listener)

Tell if the listener exists in the queue.

Parameters

Closure|object $listener The listener.

Return Value

boolean True if it exists, false otherwise.

at line line 137
mixed getPriority(Closure|object $listener, mixed $default = null)

Get the priority of the given listener.

Parameters

Closure|object $listener The listener.
mixed $default The default value to return if the listener doesn't exist.

Return Value

mixed The listener priority if it exists, null otherwise.

at line line 154
object[] getAll()

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

Return Value

object[] An array of listeners.

at line line 176
SplPriorityQueue getIterator()

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

Return Value

SplPriorityQueue The inner queue.

at line line 196
integer count()

Count the number of listeners in the queue.

Return Value

integer The number of listeners in the queue.