construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="recursivetreeiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>RecursiveTreeIterator::__construct</refname>
  <refpurpose>Construct a RecursiveTreeIterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="RecursiveTreeIterator">
   <modifier>public</modifier> <methodname>RecursiveTreeIterator::__construct</methodname>
   <methodparam><type class="union"><type>RecursiveIterator</type><type>IteratorAggregate</type></type><parameter>iterator</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RecursiveTreeIterator::BYPASS_KEY</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>cachingIteratorFlags</parameter><initializer>CachingIterator::CATCH_GET_CHILD</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>RecursiveTreeIterator::SELF_FIRST</initializer></methodparam>
  </constructorsynopsis>
  <para>
   Constructs a new <classname>RecursiveTreeIterator</classname> from the supplied recursive iterator.
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>iterator</parameter></term>
     <listitem>
      <para>
       The <classname>RecursiveIterator</classname> or <classname>IteratorAggregate</classname> to iterate over.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Flags may be provided which will affect the behavior of some methods. 
       A list of the flags can found under <link linkend="recursivetreeiterator.constants">RecursiveTreeIterator predefined constants</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>caching_it_flags</parameter></term>
     <listitem>
      <para>
       Flags to affect the behavior of the <classname>RecursiveCachingIterator</classname> used internally. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Flags to affect the behavior of the <classname>RecursiveIteratorIterator</classname> used internally. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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
-->