1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 294375 $ -->
<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;
<methodsynopsis>
<methodname>RecursiveTreeIterator::__construct</methodname>
<methodparam><type>RecursiveIterator|IteratorAggregate</type><parameter>it</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RecursiveTreeIterator::BYPASS_KEY</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cit_flags</parameter><initializer>CachingIterator::CATCH_GET_CHILD</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>RecursiveIteratorIterator::SELF_FIRST</initializer></methodparam>
</methodsynopsis>
<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>it</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>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</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
-->
|
