archived-doc-fr/reference/spl/filesystemiterator/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a7d00d0b9169ac0ca5e35dbed32ee288f4614586 Maintainer: jpauli Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="filesystemiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>FilesystemIterator::__construct</refname>
  <refpurpose>Construit un objet FilesystemIterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="FilesystemIterator">
   <modifier>public</modifier> <methodname>FilesystemIterator::__construct</methodname>
   <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS</initializer></methodparam>
  </constructorsynopsis>
  <para>
   Construit un objet FilesystemIterator, configuré avec
   le chemin <parameter>directory</parameter>.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       Le chemin du dossier dans lequel on va travailler.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Les options qui affectent le comportement des méthodes.
       La liste des options est disponible dans 
       <link linkend="filesystemiterator.constants">les constantes de <classname>FilesystemIterator</classname></link>. 
       Elles peuvent aussi être activées ultérieurement avec 
       <methodname>FilesystemIterator::setFlags</methodname>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lance une exception <classname>UnexpectedValueException</classname>
   si le répertoire n'existe pas.
  </para>
  <para>
   Lance une exception <classname>ValueError</classname>
   si <parameter>directory</parameter> est une chaîne vide.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
        Antérieur à PHP 8.2.0, <constant>FilesystemIterator::SKIP_DOTS</constant>
        était toujours activé et ne pouvait pas être désactivé.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Lance désormais une exception <classname>ValueError</classname>
        quand <parameter>directory</parameter> est une chaîne vide ;
        Auparavant, une <classname>RuntimeException</classname> était lancée.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>FilesystemIterator::__construct</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$it = new FilesystemIterator(dirname(__FILE__), FilesystemIterator::CURRENT_AS_FILEINFO);
foreach ($it as $fileinfo) {
    echo $fileinfo->getFilename() . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs.82.similar;
    <screen>
<![CDATA[
.
..
apples.jpg
banana.jpg
example.php
]]>
    </screen>
    <para>Le résultat de l'exemple ci-dessus, avant PHP 8.2.0, est similaire à :</para>
    <screen>
<![CDATA[
apples.jpg
banana.jpg
example.php
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>FilesystemIterator::setFlags</methodname></member>
    <member><methodname>DirectoryIterator::__construct</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
-->