<!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 values at a given index</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-deque.get.html">Ds\Deque::get</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-deque.isempty.html">Ds\Deque::isEmpty</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.insert" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Deque::insert</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Deque::insert</span> — <span class="dc-title">Inserts values at a given index</span></p> </div> <div class="refsect1 description" id="refsect1-ds-deque.insert-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::insert</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></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"> Inserts values into the deque at a given index. </p> </div> <div class="refsect1 parameters" id="refsect1-ds-deque.insert-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">index</code></dt> <dd> <p class="para"> The index at which to insert. <code class="code">0 <= index <= count</code> </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> You can insert at the index equal to the number of values. </p> </p></blockquote> </dd> <dt> <code class="parameter">values</code></dt> <dd> <p class="para"> The value or values to insert. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-ds-deque.insert-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 errors" id="refsect1-ds-deque.insert-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> <a href="class.outofrangeexception.html" class="classname">OutOfRangeException</a> if the index is not valid. </p> </div> <div class="refsect1 examples" id="refsect1-ds-deque.insert-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5222"> <p><strong>Example #1 <span class="function"><strong>Ds\Deque::insert()</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">();<br /><br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">"e"</span><span style="color: #007700">); </span><span style="color: #FF8000">// [e]<br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"f"</span><span style="color: #007700">); </span><span style="color: #FF8000">// [e, f]<br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">"g"</span><span style="color: #007700">); </span><span style="color: #FF8000">// [e, f, g]<br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">"a"</span><span style="color: #007700">, </span><span style="color: #DD0000">"b"</span><span style="color: #007700">); </span><span style="color: #FF8000">// [a, b, e, f, g]<br /></span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, ...[</span><span style="color: #DD0000">"c"</span><span style="color: #007700">, </span><span style="color: #DD0000">"d"</span><span style="color: #007700">]); </span><span style="color: #FF8000">// [a, b, c, d, e, f, g]<br /><br /></span><span style="color: #0000BB">var_dump</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> object(Ds\Deque)#1 (7) { [0]=> string(1) "a" [1]=> string(1) "b" [2]=> string(1) "c" [3]=> string(1) "d" [4]=> string(1) "e" [5]=> string(1) "f" [6]=> string(1) "g" } </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.get.html">Ds\Deque::get</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-deque.isempty.html">Ds\Deque::isEmpty</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>