philip Wed May 28 14:28:14 2003 EDT
Added files:
/phpdoc/en/reference/dir/functions scandir.xml
Log:
Initial documentation.
Index: phpdoc/en/reference/dir/functions/scandir.xml
+++ phpdoc/en/reference/dir/functions/scandir.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.scandir">
<refnamediv>
<refname>scandir</refname>
<refpurpose>
List files and directories inside the specified path
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>scandir</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>sorting_order</parameter></methodparam>
</methodsynopsis>
<para>
Returns an <type>array</type> of files and directories from the
<parameter>directory</parameter>. If <parameter>directory</parameter>
is not a directory, then boolean &false; is returned, and an error of
level <constant>E_WARNING</constant> is generated.
</para>
<para>
By default, the sorted order is alphabetical in ascending order. If
the optional <parameter>sorting_order</parameter> is used (set to 1),
then sort order is alphabetical in descending order.
</para>
<para>
<example>
<title>A simple <function>scandir</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dir = '/tmp';
$files1 = scandir($dir);
$files2 = scandir($dir, 1);
print_r($files1);
print_r($files2);
/* Outputs something like:
Array
(
[0] => .
[1] => ..
[2] => bar.php
[3] => foo.txt
[4] => somedir
)
Array
(
[0] => somedir
[1] => foo.txt
[2] => bar.php
[3] => ..
[4] => .
)
*/
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>PHP 4 alternatives to <function>scandir</function></title>
<programlisting role="php">
<![CDATA[
<?php
$dir = "/tmp";
$dh = opendir($dir);
while (false !== ($filename = readdir($dh))) {
$files[] = $filename;
}
sort($files);
print_r($files);
rsort($files);
print_r($files);
/* Outputs something like:
Array
(
[0] => .
[1] => ..
[2] => bar.php
[3] => foo.txt
[4] => somedir
)
Array
(
[0] => somedir
[1] => foo.txt
[2] => bar.php
[3] => ..
[4] => .
)
*/
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>opendir</function>,
<function>readdir</function>,
<function>glob</function>,
<function>is_dir</function>, and
<function>sort</function>.
</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:"../../../../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
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
