<!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>The Queue class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-stack.toarray.html">Ds\Stack::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-queue.allocate.html">Ds\Queue::allocate</a></div>
<div class="up"><a href="book.ds.html">Data Structures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.ds-queue" class="reference">
<h1 class="title">The Queue class</h1>
<div class="partintro"><p class="verinfo">(No version information available, might only be in Git)</p>
<div class="section" id="ds-queue.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A Queue is a “first in, first out” or “FIFO” collection that only allows
access to the value at the front of the queue and iterates in that order,
destructively.
</p>
</div>
<div class="section" id="ds-queue.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Ds\Queue</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><strong class="interfacename">Ds\Collection</strong></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">int</span>
<var class="fieldsynopsis_varname"><a href="class.ds-queue.html#ds-queue.constants.min-capacity"><var class="varname">MIN_CAPACITY</var></a></var>
<span class="initializer"> = 8</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-queue.allocate.html" class="methodname">allocate</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$capacity</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="ds-queue.capacity.html" class="methodname">capacity</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-queue.clear.html" class="methodname">clear</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Ds\Queue</span> <span class="methodname"><a href="ds-queue.copy.html" class="methodname">copy</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="ds-queue.isempty.html" class="methodname">isEmpty</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-queue.peek.html" class="methodname">peek</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-queue.pop.html" class="methodname">pop</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-queue.push.html" class="methodname">push</a></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...values</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="ds-queue.toarray.html" class="methodname">toArray</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="ds-queue.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="ds-queue.constants.min-capacity"><strong><code>Ds\Queue::MIN_CAPACITY</code></strong></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="ds-queue.allocate.html">Ds\Queue::allocate</a> — Allocates enough memory for a required capacity</li><li><a href="ds-queue.capacity.html">Ds\Queue::capacity</a> — Returns the current capacity</li><li><a href="ds-queue.clear.html">Ds\Queue::clear</a> — Removes all values</li><li><a href="ds-queue.construct.html">Ds\Queue::__construct</a> — Creates a new instance</li><li><a href="ds-queue.copy.html">Ds\Queue::copy</a> — Returns a shallow copy of the queue</li><li><a href="ds-queue.count.html">Ds\Queue::count</a> — Returns the number of values in the queue</li><li><a href="ds-queue.isempty.html">Ds\Queue::isEmpty</a> — Returns whether the queue is empty</li><li><a href="ds-queue.jsonserialize.html">Ds\Queue::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="ds-queue.peek.html">Ds\Queue::peek</a> — Returns the value at the front of the queue</li><li><a href="ds-queue.pop.html">Ds\Queue::pop</a> — Removes and returns the value at the front of the queue</li><li><a href="ds-queue.push.html">Ds\Queue::push</a> — Pushes values into the queue</li><li><a href="ds-queue.toarray.html">Ds\Queue::toArray</a> — Converts the queue to an array</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-stack.toarray.html">Ds\Stack::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-queue.allocate.html">Ds\Queue::allocate</a></div>
<div class="up"><a href="book.ds.html">Data Structures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
