Files
doc-fr/reference/dir/functions/dir.xml
George Peter Banyard a8cc0957ba Apply b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3
Generate methodsynopses based on stubs for recent changes
2021-10-02 22:55:28 +01:00

146 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dir</refname>
<refpurpose>Retourne une instance de la classe Directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Directory</type><type>false</type></type><methodname>dir</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Un mécanisme pseudo-objet permet la lecture d'un dossier.
L'argument <parameter>directory</parameter> est ouvert.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>directory</parameter></term>
<listitem>
<para>
Le dossier à ouvrir
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
&note.context-support;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne une instance de la classe <classname>Directory</classname>
en cas de succès, ou &false; en cas d'erreur.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>context</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>dir</function></title>
<para>
Notez la façon dont la valeur de retour de <function>Directory::read</function>
est vérifiée dans l'exemple suivant. Nous testons si la valeur est
identique (égale et de même type que -- voyez <link
linkend="language.operators.comparison">opérateurs de comparaison</link>
pour plus de détails) &false; sinon, toute entrée dans le nom serait évalué
à &false; causera l'arrêt de la boucle.
</para>
<programlisting role="php">
<![CDATA[
<?php
$d = dir("/etc/php5");
echo "Pointeur : " . $d->handle . "\n";
echo "Chemin : " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
echo $entry."\n";
}
$d->close();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Pointeur : Resource id #2
Chemin : /etc/php5
.
..
apache
cgi
cli
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
L'ordre dans lequel les entrées du dossier sont retournées avec la
méthode read dépend de votre système.
</para>
</note>
</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
-->