SplPriorityQueue (class)

The SplPriorityQueue class

Introduction

(PHP 5 >= 5.3.0, PHP 7)

The SplPriorityQueue class provides the main functionalities of a prioritized queue, implemented using a max heap.

Class synopsis

public int compare ( mixed $priority1 , mixed $priority2 )

public int count ( void )

public mixed current ( void )

public mixed extract ( void )

public void insert ( mixed $value , mixed $priority )

public bool isEmpty ( void )

public mixed key ( void )

public void next ( void )

public void recoverFromCorruption ( void )

public void rewind ( void )

public void setExtractFlags ( int $flags )

public mixed top ( void )

public bool valid ( void )

Table of Contents

• SplPriorityQueue::compare — Compare priorities in order to place elements correctly in the heap while sifting up.
• SplPriorityQueue::__construct — Constructs a new empty queue
• SplPriorityQueue::count — Counts the number of elements in the queue.
• SplPriorityQueue::current — Return current node pointed by the iterator
• SplPriorityQueue::extract — Extracts a node from top of the heap and shift up.
• SplPriorityQueue::insert — Inserts an element in the queue by sifting it up.
• SplPriorityQueue::isEmpty — Checks whether the queue is empty.
• SplPriorityQueue::key — Return current node index
• SplPriorityQueue::next — Move to the next node
• SplPriorityQueue::recoverFromCorruption — Recover from the corrupted state and allow further actions on the queue.
• SplPriorityQueue::rewind — Rewind iterator back to the start (no-op)
• SplPriorityQueue::setExtractFlags — Sets the mode of extraction
• SplPriorityQueue::top — Peeks at the node from the top of the queue
• SplPriorityQueue::valid — Check whether the queue contains more nodes