mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
236 lines
9.3 KiB
XML
236 lines
9.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<reference xml:id="class.filesystemiterator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<title>The FilesystemIterator class</title>
|
|
<titleabbrev>FilesystemIterator</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ FilesystemIterator intro -->
|
|
<section xml:id="filesystemiterator.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
The Filesystem iterator
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="filesystemiterator.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis class="class">
|
|
<ooclass>
|
|
<classname>FilesystemIterator</classname>
|
|
</ooclass>
|
|
|
|
<ooclass>
|
|
<modifier>extends</modifier>
|
|
<classname>DirectoryIterator</classname>
|
|
</ooclass>
|
|
|
|
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.current-mode-mask">FilesystemIterator::CURRENT_MODE_MASK</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.current-as-pathname">FilesystemIterator::CURRENT_AS_PATHNAME</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.current-as-fileinfo">FilesystemIterator::CURRENT_AS_FILEINFO</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.current-as-self">FilesystemIterator::CURRENT_AS_SELF</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.key-mode-mask">FilesystemIterator::KEY_MODE_MASK</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.key-as-pathname">FilesystemIterator::KEY_AS_PATHNAME</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.follow-symlinks">FilesystemIterator::FOLLOW_SYMLINKS</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.key-as-filename">FilesystemIterator::KEY_AS_FILENAME</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.new-current-and-key">FilesystemIterator::NEW_CURRENT_AND_KEY</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.other-mode-mask">FilesystemIterator::OTHER_MODE_MASK</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.skip-dots">FilesystemIterator::SKIP_DOTS</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>const</modifier>
|
|
<type>int</type>
|
|
<varname linkend="filesystemiterator.constants.unix-paths">FilesystemIterator::UNIX_PATHS</varname>
|
|
</fieldsynopsis>
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<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'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
<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'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
|
|
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
|
|
<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'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
<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'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
<!-- {{{ FilesystemIterator constants -->
|
|
<section xml:id="filesystemiterator.constants">
|
|
&reftitle.constants;
|
|
<variablelist>
|
|
<varlistentry xml:id="filesystemiterator.constants.current-as-pathname">
|
|
<term><constant>FilesystemIterator::CURRENT_AS_PATHNAME</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>FilesystemIterator::current</methodname> return the pathname.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.current-as-fileinfo">
|
|
<term><constant>FilesystemIterator::CURRENT_AS_FILEINFO</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>FilesystemIterator::current</methodname> return an <classname>SplFileInfo</classname> instance.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.current-as-self">
|
|
<term><constant>FilesystemIterator::CURRENT_AS_SELF</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>FilesystemIterator::current</methodname> return $this (the FilesystemIterator).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.current-mode-mask">
|
|
<term><constant>FilesystemIterator::CURRENT_MODE_MASK</constant></term>
|
|
<listitem>
|
|
<para>Masks <methodname>FilesystemIterator::current</methodname></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.key-as-pathname">
|
|
<term><constant>FilesystemIterator::KEY_AS_PATHNAME</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>FilesystemIterator::key</methodname> return the pathname.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.key-as-filename">
|
|
<term><constant>FilesystemIterator::KEY_AS_FILENAME</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>FilesystemIterator::key</methodname> return the filename.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.follow-symlinks">
|
|
<term><constant>FilesystemIterator::FOLLOW_SYMLINKS</constant></term>
|
|
<listitem>
|
|
<para>Makes <methodname>RecursiveDirectoryIterator::hasChildren</methodname> follow symlinks.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.key-mode-mask">
|
|
<term><constant>FilesystemIterator::KEY_MODE_MASK</constant></term>
|
|
<listitem>
|
|
<para>Masks <methodname>FilesystemIterator::key</methodname></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.new-current-and-key">
|
|
<term><constant>FilesystemIterator::NEW_CURRENT_AND_KEY</constant></term>
|
|
<listitem>
|
|
<para>Same as <literal>FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.other-mode-mask">
|
|
<term><constant>FilesystemIterator::OTHER_MODE_MASK</constant></term>
|
|
<listitem>
|
|
<para>Mask used for <methodname>FilesystemIterator::getFlags</methodname> and <methodname>FilesystemIterator::setFlags</methodname>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.skip-dots">
|
|
<term><constant>FilesystemIterator::SKIP_DOTS</constant></term>
|
|
<listitem>
|
|
<para>Skips dot files (<literal>.</literal> and <literal>..</literal>).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="filesystemiterator.constants.unix-paths">
|
|
<term><constant>FilesystemIterator::UNIX_PATHS</constant></term>
|
|
<listitem>
|
|
<para>
|
|
Makes paths use Unix-style forward slash irrespective of system default.
|
|
Note that the <parameter>path</parameter> that is passed to the
|
|
constructor is not modified.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
</partintro>
|
|
|
|
&reference.spl.entities.filesystemiterator;
|
|
|
|
</reference>
|
|
<!-- 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
|
|
-->
|