fputcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a2f3c32c3d74cef726143d5226e2093699434a62 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->

<refentry xml:id="splfileobject.fputcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileObject::fputcsv</refname>
  <refpurpose>Escribir un array de campos como una línea CSV</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>int</type><methodname>SplFileObject::fputcsv</methodname>
   <methodparam><type>array</type><parameter>fields</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>delimiter</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>
  </methodsynopsis>
  <para>
   Escribe el array <parameter>fields</parameter> en el fichero como una línea CVS.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>fields</parameter></term>
    <listitem>
     <para>
      Un array de valores.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>delimiter</parameter></term>
    <listitem>
     <para>
      El parámetro opcional <parameter>delimiter</parameter> establece el delimitador
      de campos (sólo un carácter).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>enclosure</parameter></term>
    <listitem>
     <para>
      El parámetro opcional <parameter>enclosure</parameter> establece el carácter
      circundante de cada campo (sólo un carácter).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>escape</parameter></term>
    <listitem>
     <para>
      El parámetro opcional <parameter>escape</parameter> establece el
      carácter de escape (solamente un carácter).
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la longitud del string escrito &return.falseforfailure;.
  </para>
  <para>
   Devuelve &false;, y no escribe la línea CVS en el fichero, si el parámetro
   <parameter>delimiter</parameter> o <parameter>enclosure</parameter>
   no es un único carácter.
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Emite un error de nivel <constant>E_WARNING</constant> si el parámetro
   <parameter>delimiter</parameter> o <parameter>enclosure</parameter>
   no es un único carácter.
  </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.5.21, 5.6.5</entry>
       <entry>
        Se añadió el parámetro <parameter>escape</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="splfileobject.fputcsv.examples.basic">
    <title>Ejemplo de <methodname>SplFileObject::fputcsv</methodname></title>
    <programlisting role="php">
<![CDATA[
<?php

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

$fichero = new SplFileObject('fichero.csv', 'w');

foreach ($lista as $campos) {
    $fichero->fputcsv($campos);
}

?>
]]>
    </programlisting>
    <para>El ejemplo anterior escribirá lo siguiente en <literal>fichero.csv</literal>:</para>
    <screen>
<![CDATA[
aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fputcsv</function></member>
    <member><methodname>SplFileObject::fgetcsv</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
-->