php-doc-en/reference/spl/directoryiterator/isdot.xml
Christoph Michael Becker bc4fedde59 Fix grossly misleading information
This patch has been provided by an anonymous user and solves an issue related
to the presentation of <literals> which in this case are (nearly) undistinguishable
from normal text.

Actually, we should strive for a more general solution here, since there are similar
issues in the return values section, and possibly in translations.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344926 c90b9560-bf6c-de11-be94-00142212c4b1
2018-05-02 22:00:58 +00:00

102 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="directoryiterator.isdot" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DirectoryIterator::isDot</refname>
<refpurpose>Determine if current DirectoryIterator item is '.' or '..'</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>DirectoryIterator::isDot</methodname>
<void/>
</methodsynopsis>
<para>
Determines if the current <classname>DirectoryIterator</classname>
item is a directory and either
<literal>.</literal> or <literal>..</literal>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if the entry is <literal>.</literal> or <literal>..</literal>,
otherwise &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <methodname>DirectoryIterator::isDot</methodname> example</title>
<para>
This example will list all files, omitting the <literal>.</literal> and
<literal>..</literal> entries.
</para>
<programlisting role="php">
<![CDATA[
<?php
$iterator = new DirectoryIterator(dirname(__FILE__));
foreach ($iterator as $fileinfo) {
if (!$fileinfo->isDot()) {
echo $fileinfo->getFilename() . "\n";
}
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
apple.jpg
banana.jpg
example.php
pears.jpg
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DirectoryIterator::getType</methodname></member>
<member><methodname>DirectoryIterator::isDir</methodname></member>
<member><methodname>DirectoryIterator::isFile</methodname></member>
<member><methodname>DirectoryIterator::isLink</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->