reference/spl/filesystemiterator.xml
14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60
14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<phpdoc:classref xml:id="class.filesystemiterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
5
4
6
5
<title>The FilesystemIterator class</title>
...
...
@@ -8,116 +7,120 @@
8
7
9
8
<partintro>
10
9
11
-
<!-- {{{ FilesystemIterator intro -->
10
+
<!-- {{{ FilesystemIterator intro -->
12
11
<section xml:id="filesystemiterator.intro">
13
12
&reftitle.intro;
14
13
<para>
15
14
The Filesystem iterator
16
15
</para>
17
16
</section>
18
-
<!-- }}} -->
17
+
<!-- }}} -->
19
18
20
19
<section xml:id="filesystemiterator.synopsis">
21
20
&reftitle.classsynopsis;
22
21
23
-
<!-- {{{ Synopsis -->
24
-
<classsynopsis>
25
-
<ooclass><classname>FilesystemIterator</classname></ooclass>
26
-
27
-
<!-- {{{ Class synopsis -->
28
-
<classsynopsisinfo>
29
-
<ooclass>
30
-
<classname>FilesystemIterator</classname>
31
-
</ooclass>
32
-
33
-
<ooclass>
34
-
<modifier>extends</modifier>
35
-
<classname>DirectoryIterator</classname>
36
-
</ooclass>
22
+
<!-- {{{ Synopsis -->
23
+
<classsynopsis class="class">
24
+
<ooclass>
25
+
<classname>FilesystemIterator</classname>
26
+
</ooclass>
37
27
38
-
<oointerface>
39
-
<interfacename>SeekableIterator</interfacename>
40
-
</oointerface>
28
+
<ooclass>
29
+
<modifier>extends</modifier>
30
+
<classname>DirectoryIterator</classname>
31
+
</ooclass>
41
32
42
-
</classsynopsisinfo>
43
-
<!-- }}} -->
44
-
45
-
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
33
+
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
34
+
<fieldsynopsis>
35
+
<modifier>public</modifier>
36
+
<modifier>const</modifier>
37
+
<type>int</type>
38
+
<varname linkend="filesystemiterator.constants.current-mode-mask">FilesystemIterator::CURRENT_MODE_MASK</varname>
39
+
</fieldsynopsis>
46
40
<fieldsynopsis>
41
+
<modifier>public</modifier>
47
42
<modifier>const</modifier>
48
-
<type>integer</type>
43
+
<type>int</type>
49
44
<varname linkend="filesystemiterator.constants.current-as-pathname">FilesystemIterator::CURRENT_AS_PATHNAME</varname>
50
-
<initializer>32</initializer>
51
45
</fieldsynopsis>
52
46
<fieldsynopsis>
47
+
<modifier>public</modifier>
53
48
<modifier>const</modifier>
54
-
<type>integer</type>
49
+
<type>int</type>
55
50
<varname linkend="filesystemiterator.constants.current-as-fileinfo">FilesystemIterator::CURRENT_AS_FILEINFO</varname>
56
-
<initializer>0</initializer>
57
51
</fieldsynopsis>
58
52
<fieldsynopsis>
53
+
<modifier>public</modifier>
59
54
<modifier>const</modifier>
60
-
<type>integer</type>
55
+
<type>int</type>
61
56
<varname linkend="filesystemiterator.constants.current-as-self">FilesystemIterator::CURRENT_AS_SELF</varname>
62
-
<initializer>16</initializer>
63
57
</fieldsynopsis>
64
58
<fieldsynopsis>
59
+
<modifier>public</modifier>
65
60
<modifier>const</modifier>
66
-
<type>integer</type>
67
-
<varname linkend="filesystemiterator.constants.current-mode-mask">FilesystemIterator::CURRENT_MODE_MASK</varname>
68
-
<initializer>240</initializer>
61
+
<type>int</type>
62
+
<varname linkend="filesystemiterator.constants.key-mode-mask">FilesystemIterator::KEY_MODE_MASK</varname>
69
63
</fieldsynopsis>
70
64
<fieldsynopsis>
65
+
<modifier>public</modifier>
71
66
<modifier>const</modifier>
72
-
<type>integer</type>
67
+
<type>int</type>
73
68
<varname linkend="filesystemiterator.constants.key-as-pathname">FilesystemIterator::KEY_AS_PATHNAME</varname>
74
-
<initializer>0</initializer>
75
69
</fieldsynopsis>
76
70
<fieldsynopsis>
71
+
<modifier>public</modifier>
77
72
<modifier>const</modifier>
78
-
<type>integer</type>
79
-
<varname linkend="filesystemiterator.constants.key-as-filename">FilesystemIterator::KEY_AS_FILENAME</varname>
80
-
<initializer>256</initializer>
73
+
<type>int</type>
74
+
<varname linkend="filesystemiterator.constants.follow-symlinks">FilesystemIterator::FOLLOW_SYMLINKS</varname>
81
75
</fieldsynopsis>
82
76
<fieldsynopsis>
77
+
<modifier>public</modifier>
83
78
<modifier>const</modifier>
84
-
<type>integer</type>
85
-
<varname linkend="filesystemiterator.constants.follow-symlinks">FilesystemIterator::FOLLOW_SYMLINKS</varname>
86
-
<initializer>512</initializer>
79
+
<type>int</type>
80
+
<varname linkend="filesystemiterator.constants.key-as-filename">FilesystemIterator::KEY_AS_FILENAME</varname>
87
81
</fieldsynopsis>
88
82
<fieldsynopsis>
83
+
<modifier>public</modifier>
89
84
<modifier>const</modifier>
90
-
<type>integer</type>
91
-
<varname linkend="filesystemiterator.constants.key-mode-mask">FilesystemIterator::KEY_MODE_MASK</varname>
92
-
<initializer>3840</initializer>
85
+
<type>int</type>
86
+
<varname linkend="filesystemiterator.constants.new-current-and-key">FilesystemIterator::NEW_CURRENT_AND_KEY</varname>
93
87
</fieldsynopsis>
94
88
<fieldsynopsis>
89
+
<modifier>public</modifier>
95
90
<modifier>const</modifier>
96
-
<type>integer</type>
97
-
<varname linkend="filesystemiterator.constants.new-current-and-key">FilesystemIterator::NEW_CURRENT_AND_KEY</varname>
98
-
<initializer>256</initializer>
91
+
<type>int</type>
92
+
<varname linkend="filesystemiterator.constants.other-mode-mask">FilesystemIterator::OTHER_MODE_MASK</varname>
99
93
</fieldsynopsis>
100
94
<fieldsynopsis>
95
+
<modifier>public</modifier>
101
96
<modifier>const</modifier>
102
-
<type>integer</type>
97
+
<type>int</type>
103
98
<varname linkend="filesystemiterator.constants.skip-dots">FilesystemIterator::SKIP_DOTS</varname>
104
-
<initializer>4096</initializer>
105
99
</fieldsynopsis>
106
100
<fieldsynopsis>
101
+
<modifier>public</modifier>
107
102
<modifier>const</modifier>
108
-
<type>integer</type>
103
+
<type>int</type>
109
104
<varname linkend="filesystemiterator.constants.unix-paths">FilesystemIterator::UNIX_PATHS</varname>
110
-
<initializer>8192</initializer>
111
105
</fieldsynopsis>
112
106
113
107
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
114
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
108
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='FilesystemIterator'])">
109
+
<xi:fallback/>
110
+
</xi:include>
111
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='FilesystemIterator'])">
112
+
<xi:fallback/>
113
+
</xi:include>
115
114
116
115
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
117
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.directoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
118
-
116
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.directoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DirectoryIterator'])">
117
+
<xi:fallback/>
118
+
</xi:include>
119
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfileinfo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplFileInfo'])">
120
+
<xi:fallback/>
121
+
</xi:include>
119
122
</classsynopsis>
120
-
<!-- }}} -->
123
+
<!-- }}} -->
121
124
122
125
</section>
123
126
...
...
@@ -179,6 +182,12 @@
179
182
<para>Same as <literal>FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO</literal>.</para>
180
183
</listitem>
181
184
</varlistentry>
185
+
<varlistentry xml:id="filesystemiterator.constants.other-mode-mask">
186
+
<term><constant>FilesystemIterator::OTHER_MODE_MASK</constant></term>
187
+
<listitem>
188
+
<para>Mask used for <methodname>FilesystemIterator::getFlags</methodname> and <methodname>FilesystemIterator::setFlags</methodname>.</para>
189
+
</listitem>
190
+
</varlistentry>
182
191
<varlistentry xml:id="filesystemiterator.constants.skip-dots">
183
192
<term><constant>FilesystemIterator::SKIP_DOTS</constant></term>
184
193
<listitem>
...
...
@@ -199,53 +208,28 @@
199
208
</section>
200
209
<!-- }}} -->
201
210
202
-
<!-- {{{ Changelog -->
203
-
<section role="changelog">
204
-
&reftitle.changelog;
205
-
<para>
206
-
<informaltable>
207
-
<tgroup cols="2">
208
-
<thead>
209
-
<row>
210
-
<entry>&Version;</entry>
211
-
<entry>&Description;</entry>
212
-
</row>
213
-
</thead>
214
-
<tbody>
215
-
<row>
216
-
<entry>5.3.1</entry>
217
-
<entry>Added <constant>FilesystemIterator::FOLLOW_SYMLINKS</constant></entry>
218
-
</row>
219
-
</tbody>
220
-
</tgroup>
221
-
</informaltable>
222
-
</para>
223
-
</section>
224
-
<!-- }}} -->
225
-
226
211
</partintro>
227
212
228
213
&reference.spl.entities.filesystemiterator;
229
214
230
215
</phpdoc:classref>
231
-
232
216
<!-- Keep this comment at the end of the file
233
-
Local variables:
234
-
mode: sgml
235
-
sgml-omittag:t
236
-
sgml-shorttag:t
237
-
sgml-minimize-attributes:nil
238
-
sgml-always-quote-attributes:t
239
-
sgml-indent-step:1
240
-
sgml-indent-data:t
241
-
indent-tabs-mode:nil
242
-
sgml-parent-document:nil
243
-
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
244
-
sgml-exposed-tags:nil
245
-
sgml-local-catalogs:nil
246
-
sgml-local-ecat-files:nil
247
-
End:
248
-
vim600: syn=xml fen fdm=syntax fdl=2 si
249
-
vim: et tw=78 syn=sgml
250
-
vi: ts=1 sw=1
251
-
-->
217
+
Local variables:
218
+
mode: sgml
219
+
sgml-omittag:t
220
+
sgml-shorttag:t
221
+
sgml-minimize-attributes:nil
222
+
sgml-always-quote-attributes:t
223
+
sgml-indent-step:1
224
+
sgml-indent-data:t
225
+
indent-tabs-mode:nil
226
+
sgml-parent-document:nil
227
+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
228
+
sgml-exposed-tags:nil
229
+
sgml-local-catalogs:nil
230
+
sgml-local-ecat-files:nil
231
+
End:
232
+
vim600: syn=xml fen fdm=syntax fdl=2 si
233
+
vim: et tw=78 syn=sgml
234
+
vi: ts=1 sw=1
235
+
-->
252
236