SplMinHeap::compare
SplPriorityQueue::compare
Datastructures
PHP Manual

# The SplPriorityQueue class

## Introduction

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

## Class synopsis

SplPriorityQueue
SplPriorityQueue implements Iterator , Countable {
/* Methods */
SplPriorityQueue::__construct ( void )
void SplPriorityQueue::compare ( mixed `$priority1` , mixed `$priority2` )
int SplPriorityQueue::count ( void )
mixed SplPriorityQueue::current ( void )
mixed SplPriorityQueue::extract ( void )
void SplPriorityQueue::insert ( mixed `$value` , mixed `$priority` )
bool SplPriorityQueue::isEmpty ( void )
mixed SplPriorityQueue::key ( void )
void SplPriorityQueue::next ( void )
void SplPriorityQueue::recoverFromCorruption ( void )
void SplPriorityQueue::rewind ( void )
void SplPriorityQueue::setExtractFlags ( int `$flags` )
mixed SplPriorityQueue::top ( void )
bool SplPriorityQueue::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 sift 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 — Peaks at the node from the top of the queue
- SplPriorityQueue::valid — Check whether the queue contains more nodes

SplMinHeap::compare
SplPriorityQueue::compare
Datastructures
PHP Manual