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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.23 $ -->
<!-- EN-Revision: 1.25 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgetcsv">
 <refnamediv>
  <refname>fgetcsv</refname>
  <refpurpose>Renvoie la ligne courante et cherche les champs CSV</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>fgetcsv</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>escape</parameter></methodparam>
  </methodsynopsis>
  <para>
   Similaire à <function>fgets</function> mais <function>fgetcsv</function>
   analyse la ligne qu'il lit et recherche les champs <acronym>CSV</acronym>,
   qu'il va retourner dans un tableau les contenant.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>handle</parameter></term>
     <listitem>
      <para>
       Un pointeur valide sur un fichier ouvert avec <function>fopen</function>,
       <function>popen</function> ou <function>fsockopen</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Doit être plus grand que la plus grande ligne (en terme de caractères) 
       à lire dans le fichier (y compris le caractère de fin de ligne). Ce
       paramètre est optionnel depuis PHP 5. Omettre ce paramètre
       (ou le définir à 0 en PHP 5.0.4 et suivant) fait que la longueur maximale
       de la ligne n'est pas limitée, ce qui est légèrement plus lent.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>delimiter</parameter></term>
     <listitem>
      <para>
       Spécifie le séparateur (un seul caractère). Par défaut, c'est
       la virgule.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enclosure</parameter></term>
     <listitem>
      <para>
       Spécifie le caractère de délimitation (un seul caractère).
       Par défaut, c'est les guillemets doubles.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>escape</parameter></term>
     <listitem>
      <para>
       Définit le caractère d'échappement (un seul caractère). Par défaut,
       c'est un antislash (<literal>\</literal>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau indexé contenant les champs lus.
  </para>
  <note>
   <para>
    Une ligne vide dans un fichier CSV sera retournée sous la 
    forme d'un tableau contenant la valeur &null; et ne sera pas traitée 
    comme une erreur.
   </para>
  </note>
  &note.line-endings;
  <para>
   <function>fgetcsv</function> retourne &false; en cas
   d'erreur, ou en cas de fin du fichier.
  </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>5.3.0</entry>
       <entry>
        Le paramètre <parameter>escape</parameter> a été ajouté.
       </entry>
      </row>
      <row>
       <entry>4.3.5</entry>
       <entry>
        <function>fgetcsv</function> gère désormais les données binaires.
       </entry>
      </row>
      <row>
       <entry>4.3.0</entry>
       <entry>
        Le paramètre <parameter>enclosure</parameter> a été ajouté.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Lit et affiche le contenu d'un fichier CSV</title>
    <programlisting role="php">
<![CDATA[
<?php
$row = 1;
$handle = fopen("test.csv", "r");
while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
    $num = count($data);
    echo "<p> $num champs à la ligne $row: <br /></p>\n";
    $row++;
    for ($c=0; $c < $num; $c++) {
        echo $data[$c] . "<br />\n";
    }
}
fclose($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    La définition des locales entre en jeux avec cette fonction.
    Si <varname>LANG</varname> vaut, e.g. <literal>en_US.UTF-8</literal>,
    les fichiers encodés sur un octet sont mal lus par cette fonction.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>str_getcsv</function></member>
    <member><function>explode</function></member>
    <member><function>file</function></member>
    <member><function>pack</function></member>
    <member><function>fputcsv</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
-->