<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="spldoublylinkedlist.add" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SplDoublyLinkedList::add</refname>
  <refpurpose>Add/insert a new value at the specified index</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplDoublyLinkedList">
   <modifier>public</modifier> <type>void</type><methodname>SplDoublyLinkedList::add</methodname>
   <methodparam><type>int</type><parameter>index</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>

  <para>
   Insert the value <parameter>value</parameter> at the
   specified <parameter>index</parameter>, shuffling the
   previous value at that index (and all subsequent values)
   up through the list.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
       The index where the new value is to be inserted.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The new value for the <parameter>index</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws <classname>OutOfRangeException</classname> when 
   <parameter>index</parameter> is out of bounds or when 
   <parameter>index</parameter> cannot be parsed as an integer.
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
