php-doc-en/reference/spl/splqueue/setiteratormode.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="splqueue.setiteratormode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SplQueue::setIteratorMode</refname>
  <refpurpose>Sets the mode of iteration</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>SplQueue::setIteratorMode</methodname>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       There is only one iteration parameter you can modify.
      </para>
      <itemizedlist>
       <listitem>
        <simpara>The behavior of the iterator (either one or the other):</simpara>
        <itemizedlist>
         <listitem><simpara><constant>SplDoublyLinkedList::IT_MODE_DELETE</constant> (Elements are deleted by the iterator)</simpara></listitem>
         <listitem><simpara><constant>SplDoublyLinkedList::IT_MODE_KEEP</constant> (Elements are traversed by the iterator)</simpara></listitem>
        </itemizedlist>
       </listitem>
      </itemizedlist>

      <para>
       The default mode is: <constant>SplDoublyLinkedList::IT_MODE_FIFO</constant> | <constant>SplDoublyLinkedList::IT_MODE_KEEP</constant>
      </para>

      <warning>
       <para>
        The direction of iteration can not be changed for SplQueues, it is always <constant>SplDoublyLinkedList::IT_MODE_FIFO</constant>.
       </para>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws a <classname>RuntimeException</classname> on trying to change the direction of iteration by using <constant>SplDoublyLinkedList::IT_MODE_LIFO</constant>.
  </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
-->