Ds\Queue::peek

(PECL ds >= 1.0.0)

Ds\Queue::peekReturns the value at the front of the queue.

Description

public mixed Ds\Queue::peek ( void )

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

Parameters

This function has no parameters.

Return Values

The value at the front of the queue.

Errors/Exceptions

UnderflowException if empty.

Examples

Example #1 Ds\Queue::peek() example

<?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:

string(1) "a"
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top