File: RecursiveDirectoryIterator.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (155 lines) | stat: -rw-r--r-- 5,309 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
144
145
146
147
148
149
150
151
152
153
154
155
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="RecursiveDirectoryIterator" namespace="" name="RecursiveDirectoryIterator">
  <implements name="SeekableIterator" full="SeekableIterator"/>
  <constant name="CURRENT_AS_PATHNAME" value="32">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CURRENT_AS_FILEINFO" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CURRENT_AS_SELF" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CURRENT_MODE_MASK" value="240">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="KEY_AS_PATHNAME" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="KEY_AS_FILENAME" value="256">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="FOLLOW_SYMLINKS" value="512">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="KEY_MODE_MASK" value="3840">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="NEW_CURRENT_AND_KEY" value="256">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="SKIP_DOTS" value="4096">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="UNIX_PATHS" value="8192">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a RecursiveDirectoryIterator"/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="getChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an iterator for the current entry if it is a directory"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getSubPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get sub path"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getSubPathname" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get sub path and name"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="hasChildren" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether current entry is a directory and not '.' or '..'"/>
      <return type="bool"/>
    </docblock>
    <parameter name="allow_links" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return path and filename of current dir entry"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to next entry"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind dir back to the start"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="setFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </method>
</class>