fgetcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: andresdzphp Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="splfileobject.fgetcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileObject::fgetcsv</refname>
  <refpurpose>Obtiene la línea del archivo y analiza como campos CSV</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplFileObject">
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SplFileObject::fgetcsv</methodname>
   <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>
  </methodsynopsis>
  <para>
   Obtiene una línea del archivo que está en formato <acronym>CSV</acronym> y devuelve un array que contiene los campos leídos.
  </para>
  <note>
   <para>
    Esta función tiene en cuenta los ajustes de localización. Si
    <literal>LC_CTYPE</literal> es p.e. <literal>en_US.UTF-8</literal>, los archivos
    en codificaciones de un byte pueden ser leídos erróneamente por esta función.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>delimiter</parameter></term>
     <listitem>
      <para>
       El delimitador de campo (un solo carácter). El valor por defecto es una coma o el valor establecido usando <methodname>SplFileObject::setCsvControl</methodname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enclosure</parameter></term>
     <listitem>
      <para>
       El carácter circundante de cada campo (sólo un carácter). Por omisión, son comillas dobles o el valor establecido por <methodname>SplFileObject::setCsvControl</methodname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>escape</parameter></term>
     <listitem>
      <para>
       El carácter de escape (a lo sumo un carácter). Por defecto es una barra invertida (<literal>\</literal>) o el valor establecido usando <methodname>SplFileObject::setCsvControl</methodname>.
       Un string vacío (<literal>""</literal>) desactiva el mecanismo de escape propio.
      </para>
      <note>
       <simpara>
        Normalmente un carácter <parameter>enclosure</parameter> se escapa dentro
        de un campo duplicándolo; sin embargo, el carácter <parameter>escape</parameter>
        puede ser usado como una alternativa. Así que para los valores de parámetros
        por defecto <literal>""</literal> y <literal>\"</literal> tienen el mismo
        significado. Aparte de permitir espacar el carácter
        <parameter>enclosure</parameter> el carácter
        <parameter>escape</parameter> no tiene un significado especial; ni siquiera está
        destinado a escapar de sí mismo.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array indexado que contiene los campos que se leen, o &false; en caso de error.
  </para>
  <note>
   <para>
    Una línea en blanco en un archivo CSV será devuelto como un array que
    comprende un único &null; a menos que se utilice <constant>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</constant>,
    en cuyo caso se saltan las líneas vacías.
   </para>
  </note>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.4.0</entry>
       <entry>
        El parámetro <parameter>escape</parameter> ahora también acepta un
        string vacío para desactivar el mecanismo de escape propio.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <methodname>SplFileObject::fgetcsv</methodname></title>
    <programlisting role="php">
<![CDATA[
<?php
$file = new SplFileObject("data.csv");
while (!$file->eof()) {
    var_dump($file->fgetcsv());
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de <constant>SplFileObject::READ_CSV</constant></title>
    <programlisting role="php">
<![CDATA[
<?php
$file = new SplFileObject("animals.csv");
$file->setFlags(SplFileObject::READ_CSV);
foreach ($file as $row) {
    list($animal, $class, $legs) = $row;
    printf("A %s is a %s with %d legs\n", $animal, $class, $legs);
}
?>
]]>
    </programlisting>
    <para>El contenido de animals.csv</para>
    <programlisting role="txt">
<![CDATA[
crocodile,reptile,4
dolphin,mammal,0
duck,bird,2
koala,mammal,4
salmon,fish,0
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
A crocodile is a reptile with 4 legs
A dolphin is a mammal with 0 legs
A duck is a bird with 2 legs
A koala is a mammal with 4 legs
A salmon is a fish with 0 legs
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>SplFileObject::setCsvControl</methodname></member>
    <member><methodname>SplFileObject::setFlags</methodname></member>
    <member><link linkend="splfileobject.constants.read-csv">SplFileObject::READ_CSV</link></member>
    <member><methodname>SplFileObject::current</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
-->