File: RecursiveIteratorIterator.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (143 lines) | stat: -rw-r--r-- 5,378 bytes parent folder | download | duplicates (2)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="RecursiveIteratorIterator" namespace="" name="RecursiveIteratorIterator">
  <implements name="OuterIterator" full="OuterIterator"/>
  <constant name="LEAVES_ONLY" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="SELF_FIRST" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CHILD_FIRST" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CATCH_GET_CHILD" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="beginChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Begin children"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="beginIteration" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Begin Iteration"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="callGetChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get children"/>
      <return type="RecursiveIterator"/>
    </docblock>
  </method>
  <method name="callHasChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Has children"/>
      <return type="bool"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a RecursiveIteratorIterator"/>
      <return type="void"/>
    </docblock>
    <parameter name="iterator" optional="false" byreference="false" type="object" class="Traversable"/>
    <parameter name="mode" optional="true" byreference="false" type="int"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Access the current element value"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="endChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="End children"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="endIteration" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="End Iteration"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getDepth" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the current depth of the recursive iteration"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getInnerIterator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get inner iterator"/>
      <return type="iterator"/>
    </docblock>
  </method>
  <method name="getMaxDepth" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get max depth"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getSubIterator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The current active sub iterator"/>
      <return type="RecursiveIterator"/>
    </docblock>
    <parameter name="level" optional="true" byreference="false" type="int"/>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Access the current key"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move forward to the next element"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="nextElement" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Next element"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind the iterator to the first element of the top level inner iterator"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="setMaxDepth" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set max depth"/>
      <return type="void"/>
    </docblock>
    <parameter name="max_depth" optional="true" byreference="false" type="int"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether the current position is valid"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getInnerIterator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="Iterator"/>
    </docblock>
  </method>
</class>