<!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>Removes and returns a value by index</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-deque.reduce.html">Ds\Deque::reduce</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-deque.reverse.html">Ds\Deque::reverse</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.remove" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Deque::remove</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Deque::remove</span> — <span class="dc-title">Removes and returns a value by index</span></p> </div> <div class="refsect1 description" id="refsect1-ds-deque.remove-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Ds\Deque::remove</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span> )</div> <p class="para rdfs-comment"> Removes and returns a value by index. </p> </div> <div class="refsect1 parameters" id="refsect1-ds-deque.remove-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">index</code></dt> <dd> <p class="para"> The index of the value to remove. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-ds-deque.remove-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The value that was removed. </p> </div> <div class="refsect1 errors" id="refsect1-ds-deque.remove-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.remove-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5233"> <p><strong>Example #1 <span class="function"><strong>Ds\Deque::remove()</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: #DD0000">"a"</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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">remove</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">remove</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$deque</span><span style="color: #007700">-></span><span style="color: #0000BB">remove</span><span style="color: #007700">(</span><span style="color: #0000BB">0</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> string(1) "b" string(1) "a" string(1) "c" </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.reduce.html">Ds\Deque::reduce</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-deque.reverse.html">Ds\Deque::reverse</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>