File: DirectoryIterator.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 (181 lines) | stat: -rw-r--r-- 7,627 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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="DirectoryIterator" namespace="" name="DirectoryIterator">
  <implements name="SeekableIterator" full="SeekableIterator"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new directory iterator from a path"/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
  </constructor>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the current DirectoryIterator item"/>
      <return type="DirectoryIterator"/>
    </docblock>
  </method>
  <method name="getATime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get last access time of the current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getBasename" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get base name of current DirectoryIterator item"/>
      <return type="string"/>
    </docblock>
    <parameter name="suffix" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getCTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get inode change time of the current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getExtension" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the file extension"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getFilename" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return file name of current DirectoryIterator item"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getGroup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get group for the current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getInode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get inode for the current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get last modification time of current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getOwner" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get owner of current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get path of current Iterator item without filename"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPathname" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return path and file name of current DirectoryIterator item"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the permissions of current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get size of current DirectoryIterator item"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine the type of the current DirectoryIterator item"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="isDir" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item is a directory"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isDot" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item is '.' or '..'"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isExecutable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item is executable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item is a regular file"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isLink" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item is a symbolic link"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isReadable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item can be read"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isWritable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if current DirectoryIterator item can be written to"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the key for the current DirectoryIterator item"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move forward to next DirectoryIterator item"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind the DirectoryIterator back to the start"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="seek" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Seek to a DirectoryIterator item"/>
      <return type="void"/>
    </docblock>
    <parameter name="position" optional="false" byreference="false" type="int"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get file name as a string"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether current DirectoryIterator position is a valid file"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>