Specialized priority queue implementation for use with an intercepting filter chain.

Allows removal

 Methods

compare()

compare() 
Inherited

inherited_from SplPriorityQueue::compare()
inherited_from \Zend\Stdlib\SplPriorityQueue::compare()

Does the queue contain a given value?

contains(mixed $datum) : bool

Parameters

$datum

mixed

Returns

bool

count()

count() 
Inherited

inherited_from SplPriorityQueue::count()
inherited_from \Zend\Stdlib\SplPriorityQueue::count()

current()

current() 
Inherited

inherited_from SplPriorityQueue::current()
inherited_from \Zend\Stdlib\SplPriorityQueue::current()

extract()

extract() 
Inherited

inherited_from SplPriorityQueue::extract()
inherited_from \Zend\Stdlib\SplPriorityQueue::extract()

Insert a value with a given priority

insert(mixed $datum, mixed $priority) : void
Inherited

Utilizes {@var $serial} to ensure that values of equal priority are emitted in the same order in which they are inserted.

inherited_from \Zend\Stdlib\SplPriorityQueue::insert()

Parameters

$datum

mixed

$priority

mixed

isEmpty()

isEmpty() 
Inherited

inherited_from SplPriorityQueue::isEmpty()
inherited_from \Zend\Stdlib\SplPriorityQueue::isEmpty()

key()

key() 
Inherited

inherited_from SplPriorityQueue::key()
inherited_from \Zend\Stdlib\SplPriorityQueue::key()

recoverFromCorruption()

recoverFromCorruption() 
Inherited

inherited_from SplPriorityQueue::recoverFromCorruption()
inherited_from \Zend\Stdlib\SplPriorityQueue::recoverFromCorruption()

Remove a value from the queue

remove(mixed $datum) : bool

This is an expensive operation. It must first iterate through all values, and then re-populate itself. Use only if absolutely necessary.

Parameters

$datum

mixed

Returns

bool

rewind()

rewind() 
Inherited

inherited_from SplPriorityQueue::rewind()
inherited_from \Zend\Stdlib\SplPriorityQueue::rewind()

Serialize

serialize() : string
Inherited

inherited_from \Zend\Stdlib\SplPriorityQueue::serialize()

Returns

string

setExtractFlags()

setExtractFlags() 
Inherited

inherited_from SplPriorityQueue::setExtractFlags()
inherited_from \Zend\Stdlib\SplPriorityQueue::setExtractFlags()

Serialize to an array

toArray() : array
Inherited

Array will be priority => data pairs

inherited_from \Zend\Stdlib\SplPriorityQueue::toArray()

Returns

array

top()

top() 
Inherited

inherited_from SplPriorityQueue::top()
inherited_from \Zend\Stdlib\SplPriorityQueue::top()

Deserialize

unserialize(string $data) : void
Inherited

inherited_from \Zend\Stdlib\SplPriorityQueue::unserialize()

Parameters

$data

string

valid()

valid() 
Inherited

inherited_from SplPriorityQueue::valid()
inherited_from \Zend\Stdlib\SplPriorityQueue::valid()

 Properties

 

<p>Seed used to ensure queue order for items of the same priority</p>

$serial : int
Inherited

inherited_from \Zend\Stdlib\SplPriorityQueue::$$serial