mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
196 lines
4.2 KiB
XML
196 lines
4.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<refentry xml:id="function.scandir" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>scandir</refname>
|
|
<refpurpose>List files and directories inside the specified path</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns an <type>array</type> of files and directories from the
|
|
<parameter>directory</parameter>.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>directory</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The directory that will be scanned.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sorting_order</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
By default, the sorted order is alphabetical in ascending order. If
|
|
the optional <parameter>sorting_order</parameter> is used (set to 1),
|
|
then the sort order is alphabetical in descending order.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
For a description of the <parameter>context</parameter> parameter,
|
|
refer to <link linkend="ref.stream">the streams section</link> of
|
|
the manual.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an <type>array</type> of filenames on success, or &false; on
|
|
failure. 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[0] => .
|
|
[1] => ..
|
|
[2] => bar.php
|
|
[3] => foo.txt
|
|
[4] => somedir
|
|
)
|
|
Array
|
|
(
|
|
[0] => somedir
|
|
[1] => foo.txt
|
|
[2] => bar.php
|
|
[3] => ..
|
|
[4] => .
|
|
)
|
|
]]>
|
|
</screen>
|
|
</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);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[0] => .
|
|
[1] => ..
|
|
[2] => bar.php
|
|
[3] => foo.txt
|
|
[4] => somedir
|
|
)
|
|
Array
|
|
(
|
|
[0] => somedir
|
|
[1] => foo.txt
|
|
[2] => bar.php
|
|
[3] => ..
|
|
[4] => .
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&tip.fopen-wrapper;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>opendir</function></member>
|
|
<member><function>readdir</function></member>
|
|
<member><function>glob</function></member>
|
|
<member><function>is_dir</function></member>
|
|
<member><function>sort</function></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:"../../../../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
|
|
-->
|