doc-fr/reference/filesystem/functions/glob.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f739452fff4a12d64c78a3656640ed03fcfe91d0 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.glob" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>glob</refname>
  <refpurpose>Recherche des chemins qui vérifient un masque</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>glob</methodname>
   <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>glob</function> recherche tous les chemins qui vérifient
   le masque <parameter>pattern</parameter>, en suivant les règles utilisées par
   la fonction <literal>glob()</literal> de la libc, qui sont les mêmes que celles
   utilisées par le Shell en général.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      <para>
       Le masque. Aucun remplacement de tilde
       (<literal>~</literal>) ou de paramètre n'est fait.
      </para>
      <para>
       Caractères spéciaux :
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>*</literal> - Associe zéro ou plus de caractères.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>?</literal> - Associe exactement un caractère (n'importe
          quel caractère).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>[...]</literal> - Associe un caractère d'un ensemble de
          caractères. Si le premier caractère est <literal>!</literal>,
          associe n'importe quel caractères pas dans cet ensemble.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>\</literal> - Échappe le caractère suivant, sauf quand le
          drapeau <constant>GLOB_NOESCAPE</constant> est utilisé.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Les drapeaux valides sont :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>GLOB_MARK</constant> : Ajoute un slash final (un antislash
          sous Windows) à chaque dossier retourné
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_NOSORT</constant> : Retourne les fichiers dans l'ordre d'apparence (pas de tri).
          Lorsque ce drapeau n'est pas utilisé, les noms des champs sont triés alphabétiquement
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_NOCHECK</constant> : Retourne le masque de recherche si aucun fichier n'a été trouvé
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_NOESCAPE</constant> : Ne protège aucun métacaractère d'un antislash
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_BRACE</constant> : Remplace {a,b,c} par 'a', 'b' ou 'c'
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_ONLYDIR</constant> : Ne retourne que les dossiers qui vérifient le masque
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GLOB_ERR</constant> : Stop lors d'une erreur (comme des dossiers non lisibles),
          par défaut, les erreurs sont ignorées.
         </simpara>
        </listitem>
       </itemizedlist>
       <note>
        <simpara>
         Le drapeau <constant>GLOB_BRACE</constant> n'est pas disponible sur certains
         systèmes non GNU, tel que Solaris ou Alpine Linux.
        </simpara>
       </note>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau contenant les fichiers et dossiers correspondant au
   masque, un tableau vide s'il n'y a aucune correspondance, ou &false; si
   une erreur survient.
  </para>
  <note>
   <para>
    Sous certains systèmes, il est impossible de distinguer un masque vide
    d'une erreur.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     Un moyen pratique pour remplacer <function>opendir</function> 
     par <function>glob</function>
    </title>
    <programlisting role="php">
<![CDATA[
<?php
foreach (glob("*.txt") as $filename) {
    echo "$filename occupe " . filesize($filename) . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
funclist.txt occupe 44686
funcsummary.txt occupe 267625
quickref.txt occupe 137820
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.no-remote;
  <note>
   <simpara>
    Cette fonction n'est pas disponible sur quelques systèmes (e.g. vieux Sun OS).
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>opendir</function></member>
    <member><function>readdir</function></member>
    <member><function>closedir</function></member>
    <member><function>fnmatch</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:"~/.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
-->