php8.5
Home/ Manual/ ds / queue/ Ds\Queue::peek

Ds\Queue::peek

PHP function Edit on GitHub ✎

(PECL ds >= 1.0.0)

Returns the value at the front of the queue

Description

Ds\Queue::peek(): mixed

Returns the value at the front of the queue, but does not remove it.

Parameters Parameters

Return Values

The value at the front of the queue.

Errors/Exceptions

UnderflowException if empty.

Examples

Ds\Queue::peek() example

php
<?php
$queue = new \Ds\Queue();

$queue->push("a");
$queue->push("b");
$queue->push("c");

var_dump($queue->peek());
?>

The above example will output something similar to:

output
string(1) "a"

Source: reference/ds/ds/queue/peek.xml · from the official PHP manual (php/doc-en)