<!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>Pops a value off of the front of a queue</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-queue.lock.html">pht\Queue::lock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-queue.push.html">pht\Queue::push</a></div>
<div class="up"><a href="class.pht-queue.html">pht\Queue</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pht-queue.pop" class="refentry">
<div class="refnamediv">
<h1 class="refname">pht\Queue::pop</h1>
<p class="verinfo">(PECL pht >= 0.0.1)</p><p class="refpurpose"><span class="refname">pht\Queue::pop</span> — <span class="dc-title">Pops a value off of the front of a queue</span></p>
</div>
<div class="refsect1 description" id="refsect1-pht-queue.pop-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>pht\Queue::pop</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
This method will remove a value from the front of the queue (in constant
time). Attempting to pop a value from an empty queue will result in an
<a href="class.error.html" class="classname">Error</a> exception.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pht-queue.pop-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pht-queue.pop-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The value removed from the queue.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pht-queue.pop-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4571">
<p><strong>Example #1 Popping a value from a queue</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">use </span><span style="color: #0000BB">pht</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">= new </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: #0000BB">1</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">pop</span><span style="color: #007700">());</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(1)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-queue.lock.html">pht\Queue::lock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-queue.push.html">pht\Queue::push</a></div>
<div class="up"><a href="class.pht-queue.html">pht\Queue</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
