PHP Ds\Queue peek() Function

The Ds\Queue::peek() Function in PHP is used to get the value present at the front of a Queue. This function simply returns the element present at the front of a Queue instance without actually removing it.

Syntax:

mixed public Ds\Queue::peek ( void )

Parameters: This function does not accepts any parameters.

Return Value: This function returns the value present at the front of this Queue. The return type of the function is mixed and depends on the type of value stored in the Queue.

Exception: This function throws an UnderflowException if the Queue is empty.

Below programs illustrate the Ds\Queue::peek() Function in PHP

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php 
  
// Declare new Queue 
$q = new \Ds\Queue(); 
  
// Add elements to the Queue 
$q->push("One");
$q->push("Two");
$q->push("Three");
  
echo "Queue is: \n";
print_r($q);
  
// Get element at the front
echo "\nElement at front is: ";
print_r($q->peek());
  
?> 

chevron_right


Output:

Queue is: 
Ds\Queue Object
(
    [0] => One
    [1] => Two
    [2] => Three
)

Element at front is: One

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php 
  
// Declare new Queue 
$q = new \Ds\Queue (); 
  
echo "Queue is: \n";
print_r($q);
  
// Get element at the front
echo "\nElement at front is: ";
print_r($q->peek());
  
?> 

chevron_right


Output:

PHP Fatal error:  Uncaught UnderflowException

Reference: http://php.net/manual/en/ds-priorityqueue.peek.php



My Personal Notes arrow_drop_up

The function of education is to teach one to think intensively and to think critically

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.