reference/spl/recursivedirectoryiterator/construct.xml
d51166ca16fda8e766849505b84f9306ef443f71
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="recursivedirectoryiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>RecursiveDirectoryIterator::__construct</refname>
...
...
@@ -9,14 +8,14 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<constructorsynopsis role="RecursiveDirectoryIterator">
13
12
<modifier>public</modifier> <methodname>RecursiveDirectoryIterator::__construct</methodname>
14
-
<methodparam><type>string</type><parameter>path</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
15
14
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO</initializer></methodparam>
16
-
</methodsynopsis>
15
+
</constructorsynopsis>
17
16
<para>
18
17
Constructs a <methodname>RecursiveDirectoryIterator</methodname>
19
-
for the provided <parameter>path</parameter>.
18
+
for the provided <parameter>directory</parameter>.
20
19
</para>
21
20
</refsect1>
22
21

...
...
@@ -25,7 +24,7 @@
25
24
<para>
26
25
<variablelist>
27
26
<varlistentry>
28
-
<term><parameter>path</parameter></term>
27
+
<term><parameter>directory</parameter></term>
29
28
<listitem>
30
29
<para>
31
30
The path of the directory to be iterated over.
...
...
@@ -47,18 +46,41 @@
47
46
</para>
48
47
</refsect1>
49
48

50
-
<refsect1 role="returnvalues">
51
-
&reftitle.returnvalues;
49
+
<refsect1 role="errors">
50
+
&reftitle.errors;
51
+
<para>
52
+
Throws an <classname>UnexpectedValueException</classname>
53
+
if the <parameter>directory</parameter> does not exist.
54
+
</para>
52
55
<para>
53
-
Returns the newly created <classname>RecursiveDirectoryIterator</classname>.
56
+
Throws a <classname>ValueError</classname>
57
+
if the <parameter>directory</parameter> is an empty string.
54
58
</para>
55
59
</refsect1>
56
60

57
-
<refsect1 role="errors">
58
-
&reftitle.errors;
61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
59
63
<para>
60
-
Throws an <classname>UnexpectedValueException</classname>
61
-
if the <parameter>path</parameter> cannot be found or is not a directory.
64
+
<informaltable>
65
+
<tgroup cols="2">
66
+
<thead>
67
+
<row>
68
+
<entry>&Version;</entry>
69
+
<entry>&Description;</entry>
70
+
</row>
71
+
</thead>
72
+
<tbody>
73
+
<row>
74
+
<entry>8.0.0</entry>
75
+
<entry>
76
+
Now throws a <classname>ValueError</classname> if
77
+
<parameter>directory</parameter> is an empty string;
78
+
previously it threw a <classname>RuntimeException</classname>.
79
+
</entry>
80
+
</row>
81
+
</tbody>
82
+
</tgroup>
83
+
</informaltable>
62
84
</para>
63
85
</refsect1>
64
86

...
...
@@ -123,7 +145,6 @@ Key: /tmp/veggies/carrot.xml
123
145
</refsect1>
124
146

125
147
</refentry>
126
-

127
148
<!-- Keep this comment at the end of the file
128
149
Local variables:
129
150
mode: sgml
130
151