php8.5
/
Download
Home/ Manual/ spl / splpriorityqueue/ SplPriorityQueue::getExtractFlags

SplPriorityQueue::getExtractFlags

PHP function Edit on GitHub ✎

(PHP 7, PHP 8)

Get the flags of extraction

Description

SplPriorityQueue::getExtractFlags(): int

Gets the flags that define what is extracted by SplPriorityQueue::current, SplPriorityQueue::top and SplPriorityQueue::extract.

Parameters Parameters

Return Values

Returns the flags of extraction, which is one of the following:

  • SplPriorityQueue::EXTR_DATA (0x00000001): Extract the data
  • SplPriorityQueue::EXTR_PRIORITY (0x00000002): Extract the priority
  • SplPriorityQueue::EXTR_BOTH (0x00000003): Extract an array containing both

The default is SplPriorityQueue::EXTR_DATA.

See Also

  • SplPriorityQueue::setExtractFlags
  • SplPriorityQueue::current
  • SplPriorityQueue::top
  • SplPriorityQueue::extract

Source: reference/spl/splpriorityqueue/getextractflags.xml · from the official PHP manual (php/doc-en)