fputcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 291d60430d25f2b508bebb5720b41cc68f9a6ec1 Maintainer: jpauli Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fputcsv" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fputcsv</refname>
  <refpurpose>Formate une ligne en CSV et l'écrit dans un fichier</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>fputcsv</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>array</type><parameter>fields</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>eol</parameter><initializer>"\n"</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>fputcsv</function> formate la ligne passée sous forme de
   tableau <parameter>fields</parameter>, puis écrit le résultat dans le
   fichier <parameter>stream</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.validfp.all;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fields</parameter></term>
     <listitem>
      <para>
       Un tableau de chaînes de caractères <type>string</type>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>separator</parameter></term>
     <listitem>
      <para>
       Le paramètre optionnel <parameter>separator</parameter> spécifie le
       délimiteur (un caractère d'un seul octet).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enclosure</parameter></term>
     <listitem>
      <para>
       Le paramètre <parameter>enclosure</parameter> spécifie le caractère
       d'encadrement (un caractère d'un seul octet).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>escape</parameter></term>
     <listitem>
      <para>
       Le paramètre optionnel <parameter>escape</parameter> définit le
       caractère d'échappement (au plus un caractère d'un seul octet).
       Une &string; vide (<literal>""</literal>) désactive le mécanisme d'échappement propriétaire.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>eol</parameter></term>
     <listitem>
      <para>
       Le paramètre optionnel <parameter>eol</parameter> définit une séquence
       de fin de ligne (End of Line) personnalisé.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <note>
   <para>
    Si un caractère <parameter>enclosure</parameter> est contenu dans un champ, 
    il sera échappé en le doublant, à moins qu'il ne soit immédiatement précédé 
    d'un <parameter>escape</parameter>.
   </para>
  </note> 
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la taille de la chaîne écrite &return.falseforfailure;.
  </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.1.0</entry>
       <entry>
        Le paramètre optionnel <parameter>eol</parameter> a été ajouté.
       </entry>
      </row>
      <row>
       <entry>7.4.0</entry>
       <entry>
        Le paramètre <parameter>escape</parameter> accepte désormais une chaîne de
        caractères vide afin de désactiver le mécanisme d'échapement propriétaire.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>fputcsv</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$list = array (
   array('aaa', 'bbb', 'ccc', 'dddd'),
   array('123', '456', '789'),
   array('"aaa"', '"bbb"')
);

$fp = fopen('file.csv', 'w');

foreach ($list as $fields) {
    fputcsv($fp, $fields);
}

fclose($fp);
?>
]]>
    </programlisting>
    <para>L'exemple ci-dessus va écrire ce qui suit vers <literal>file.csv</literal>:</para>
    <screen>
<![CDATA[
aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.line-endings;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fgetcsv</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
-->