<!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>Adds values to the front of the deque</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-deque.toarray.html">Ds\Deque::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.ds-map.html">Map</a></div>
<div class="up"><a href="class.ds-deque.html">Deque</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ds-deque.unshift" class="refentry">
<div class="refnamediv">
<h1 class="refname">Ds\Deque::unshift</h1>
<p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Deque::unshift</span> — <span class="dc-title">Adds values to the front of the deque</span></p>
</div>
<div class="refsect1 description" id="refsect1-ds-deque.unshift-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Ds\Deque::unshift</strong></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>
<p class="para rdfs-comment">
Adds values to the front of the deque, moving all the current
values forward to make room for the new values.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ds-deque.unshift-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">values</code></dt>
<dd>
<p class="para">
The values to add to the front of the deque.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Multiple values will be added in the same order that they are
passed.
</p>
</p></blockquote>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ds-deque.unshift-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ds-deque.unshift-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5248">
<p><strong>Example #1 <span class="function"><strong>Ds\Deque::unshift()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$deque </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Deque</span><span style="color: #007700">([</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">unshift</span><span style="color: #007700">(</span><span style="color: #DD0000">"a"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">unshift</span><span style="color: #007700">(</span><span style="color: #DD0000">"b"</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$deque</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>
Ds\Deque Object
(
[0] => b
[1] => c
[2] => a
[3] => 1
[4] => 2
[5] => 3
)
</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-deque.toarray.html">Ds\Deque::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.ds-map.html">Map</a></div>
<div class="up"><a href="class.ds-deque.html">Deque</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
