<!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>Unshifts a value to the vector front</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-vector.unlock.html">pht\Vector::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-vector.updateAt.html">pht\Vector::updateAt</a></div>
<div class="up"><a href="class.pht-vector.html">pht\Vector</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pht-vector.unshift" class="refentry">
<div class="refnamediv">
<h1 class="refname">pht\Vector::unshift</h1>
<p class="verinfo">(PECL pht >= 0.0.1)</p><p class="refpurpose"><span class="refname">pht\Vector::unshift</span> — <span class="dc-title">Unshifts a value to the vector front</span></p>
</div>
<div class="refsect1 description" id="refsect1-pht-vector.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>pht\Vector::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">$value</code></span>
)</div>
<p class="para rdfs-comment">
This method unshifts a value to the front of a vector (in linear time). The
vector will automatically be resized if it is not large enough.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pht-vector.unshift-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
The value to be pushed onto the beginning of the vector. This value will
be serialised (since it may be passed around between threads).
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-pht-vector.unshift-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No return value.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pht-vector.unshift-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4565">
<p><strong>Example #1 Unshifting a value to the front of a vector</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">Vector</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$vector </span><span style="color: #007700">= new </span><span style="color: #0000BB">Vector</span><span style="color: #007700">();<br /><br />for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">3</span><span style="color: #007700">; ++</span><span style="color: #0000BB">$i</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">unshift</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">); </span><span style="color: #FF8000">// causes a quadratic runtime, beware<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$vector</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>
object(pht\Vector)#1 (3) {
[0]=>
int(2)
[1]=>
int(1)
[2]=>
int(0)
}
</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-vector.unlock.html">pht\Vector::unlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-vector.updateAt.html">pht\Vector::updateAt</a></div>
<div class="up"><a href="class.pht-vector.html">pht\Vector</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
