mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
437bbf134e
We do this for the classes of the core and bundled extensions only, for now. This also allows us to remove some slightly incorrect and unnecessary copy and paste documentation, where inherited constants have been explicitly documented for child classes. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345662 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
4.5 KiB
XML
146 lines
4.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.recursivedirectoryiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<title>The RecursiveDirectoryIterator class</title>
|
|
<titleabbrev>RecursiveDirectoryIterator</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ RecursiveDirectoryIterator intro -->
|
|
<section xml:id="recursivedirectoryiterator.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
The <classname>RecursiveDirectoryIterator</classname> provides
|
|
an interface for iterating recursively over filesystem directories.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="recursivedirectoryiterator.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass><classname>RecursiveDirectoryIterator</classname></ooclass>
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<classname>RecursiveDirectoryIterator</classname>
|
|
</ooclass>
|
|
|
|
<ooclass>
|
|
<modifier>extends</modifier>
|
|
<classname>FilesystemIterator</classname>
|
|
</ooclass>
|
|
|
|
<oointerface>
|
|
<interfacename>SeekableIterator</interfacename>
|
|
</oointerface>
|
|
|
|
<oointerface>
|
|
<interfacename>RecursiveIterator</interfacename>
|
|
</oointerface>
|
|
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
|
|
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
|
|
<xi:fallback />
|
|
</xi:include>
|
|
|
|
<!-- {{{ If the property is documented below (xml:id=recursivedirectoryiterator.props) use this
|
|
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>string</type>
|
|
<varname linkend="recursivedirectoryiterator.props.name">name</varname>
|
|
</fieldsynopsis>
|
|
}}} -->
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivedirectoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
|
<classsynopsisinfo role="comment">Inherits</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
|
</classsynopsis>
|
|
|
|
</section>
|
|
|
|
<!-- {{{ RecursiveDirectoryIterator properties
|
|
<section xml:id="recursivedirectoryiterator.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="recursivedirectoryiterator.props.name">
|
|
<term><varname>name</varname></term>
|
|
<listitem>
|
|
<para>Prop description</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
}}} -->
|
|
|
|
<section role="changelog"><!-- {{{ -->
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
The <classname>FilesystemIterator</classname> was introduced as
|
|
the parent class. Previously, the parent was the
|
|
<classname>DirectoryIterator</classname>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Implements <interfacename>SeekableIterator</interfacename>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.2.11, 5.3.1</entry>
|
|
<entry>Added <constant>RecursiveDirectoryIterator::FOLLOW_SYMLINKS</constant></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</section><!-- }}} -->
|
|
|
|
</partintro>
|
|
|
|
&reference.spl.entities.recursivedirectoryiterator;
|
|
|
|
</phpdoc:classref>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|