<!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>Inserts a value into the vector</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="pht-vector.deleteAt.html">pht\Vector::deleteAt</a></div> <div class="next" style="text-align: right; float: right;"><a href="pht-vector.lock.html">pht\Vector::lock</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.insertAt" class="refentry"> <div class="refnamediv"> <h1 class="refname">pht\Vector::insertAt</h1> <p class="verinfo">(PECL pht >= 0.0.1)</p><p class="refpurpose"><span class="refname">pht\Vector::insertAt</span> — <span class="dc-title">Inserts a value into the vector</span></p> </div> <div class="refsect1 description" id="refsect1-pht-vector.insertAt-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::insertAt</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> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code></span> )</div> <p class="para rdfs-comment"> This method inserts a value at the specified offset into the 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.insertAt-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">value</code></dt> <dd> <p class="para"> The value to be inserted into the vector. This value will be serialised (since it may be passed around between threads). </p> </dd> <dt> <code class="parameter">offset</code></dt> <dd> <p class="para"> The offset at which the value will be inserted at. This offset must be within the 0..N range (inclusive), where N is the size of the vector. Inserting at position N is the equivalent of using <span class="methodname"><a href="pht-vector.push.html" class="methodname">pht\Vector::push()</a></span>, and inserting at position 0 is the equivalent of using <span class="methodname"><a href="pht-vector.unshift.html" class="methodname">pht\Vector::unshift()</a></span>. Attempting to insert at offsets outside of this range will result in an <a href="class.error.html" class="classname">Error</a> exception. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-pht-vector.insertAt-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No return value. </p> </div> <div class="refsect1 examples" id="refsect1-pht-vector.insertAt-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4557"> <p><strong>Example #1 Inserting a value into 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 /></span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">insertAt</span><span style="color: #007700">(</span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// insert 3 at start<br /></span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">insertAt</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// insert 1 at start (before 3)<br /></span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">insertAt</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">// insert 2 in middle (after 1 and before 3)<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(1) [1]=> int(2) [2]=> int(3) } </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.deleteAt.html">pht\Vector::deleteAt</a></div> <div class="next" style="text-align: right; float: right;"><a href="pht-vector.lock.html">pht\Vector::lock</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>