<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Returns the value at the front of the queue</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-queue.jsonserialize.html">Ds\Queue::jsonSerialize</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-queue.pop.html">Ds\Queue::pop</a></div> <div class="up"><a href="class.ds-queue.html">Queue</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="ds-queue.peek" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Queue::peek</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Queue::peek</span> — <span class="dc-title">Returns the value at the front of the queue</span></p> </div> <div class="refsect1 description" id="refsect1-ds-queue.peek-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Ds\Queue::peek</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Returns the value at the front of the queue, but does not remove it. </p> </div> <div class="refsect1 parameters" id="refsect1-ds-queue.peek-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-ds-queue.peek-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The value at the front of the queue. </p> </div> <div class="refsect1 errors" id="refsect1-ds-queue.peek-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> <a href="class.underflowexception.html" class="classname">UnderflowException</a> if empty. </p> </div> <div class="refsect1 examples" id="refsect1-ds-queue.peek-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5347"> <p><strong>Example #1 <span class="function"><strong>Ds\Queue::peek()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$queue </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Queue</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">push</span><span style="color: #007700">(</span><span style="color: #DD0000">"a"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">push</span><span style="color: #007700">(</span><span style="color: #DD0000">"b"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">push</span><span style="color: #007700">(</span><span style="color: #DD0000">"c"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">peek</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(1) "a" </pre></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-queue.jsonserialize.html">Ds\Queue::jsonSerialize</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-queue.pop.html">Ds\Queue::pop</a></div> <div class="up"><a href="class.ds-queue.html">Queue</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>