svn: /phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/ construct.xml
| From: | Peter Cowburn | Date: | Sat, 21 Aug 2010 18:27:03 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/ construct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7031@lists.php.net to get a copy of this message | ||
salathe Sat, 21 Aug 2010 18:27:03 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=302620
Log:
fleshed out recursivedirectoryiterator constructor page
Changed paths:
U phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/construct.xml
Modified: phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/construct.xml 2010-08-21 18:25:26 UTC
(rev 302619)
+++ phpdoc/en/trunk/reference/spl/recursivedirectoryiterator/construct.xml 2010-08-21 18:27:03 UTC
(rev 302620)
@@ -12,14 +12,12 @@
<methodsynopsis>
<methodname>RecursiveDirectoryIterator::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME
| FilesystemIterator::CURRENT_AS_FILEINFO</initializer></methodparam>
</methodsynopsis>
<para>
- Constructs a <methodname>RecursiveDirectoryIterator</methodname>.
+ Constructs a <methodname>RecursiveDirectoryIterator</methodname>
+ for the provided <parameter>path</parameter>.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -30,7 +28,7 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
- Directory path.
+ The path of the directory to be iterated over.
</para>
</listitem>
</varlistentry>
@@ -38,7 +36,10 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
- Optional flags.
+ Flags may be provided which will affect the behavior of some methods.
+ A list of the flags can found under
+ <link linkend="filesystemiterator.constants">FilesystemIterator predefined
constants</link>.
+ They can also be set later with
<methodname>FilesystemIterator::setFlags</methodname>.
</para>
</listitem>
</varlistentry>
@@ -49,10 +50,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.void;
+ Returns the newly created <classname>RecursiveDirectoryIterator</classname>.
</para>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws an <classname>UnexpectedValueException</classname>
+ if the <parameter>path</parameter> cannot be found or is not a directory.
+ </para>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -105,7 +114,9 @@
&reftitle.seealso;
<para>
<simplelist>
+
<member><methodname>FilesystemIterator::__construct</methodname></member>
<member><methodname>RecursiveIteratorIterator::__construct</methodname></member>
+ <member><link linkend="filesystemiterator.constants">FilesystemIterator
predefined constants</link></member>
</simplelist>
</para>
</refsect1>