<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="splfileobject.fgetcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">

<refnamediv>

<refname>SplFileObject::fgetcsv</refname>

<refpurpose>Recupera una línea del archivo y la analiza como datos 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>

Recupera una línea del archivo y la analiza como datos <acronym>CSV</acronym>

y devuelve un array que contiene todos los campos leídos.

</para>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='description']//db:note/.)">

<xi:fallback/>

</xi:include>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>separator</parameter></term>

<listitem>

<para>

El delimitador de campo (un solo carácter de un byte).

Por omisión, <literal>,</literal> o el valor definido por una llamada previa a

<methodname>SplFileObject::setCsvControl</methodname>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>enclosure</parameter></term>

<listitem>

<para>

El carácter utilizado para encerrar el valor de un campo (un carácter de un solo byte).

Por omisión, será una comilla doble o bien el valor definido utilizando

el método <methodname>SplFileObject::setCsvControl</methodname>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>escape</parameter></term>

<listitem>

<para>

El carácter de escape de campo (un solo carácter de un byte).

Por omisión, <literal>"</literal> o el valor definido por una llamada previa a

<methodname>SplFileObject::setCsvControl</methodname>.

Un &string; vacío (<literal>""</literal>) desactiva el mecanismo de escape propietario.

</para>

<xi:include xpointer="function.fgetcsv..warn.escape.parameter"/>

<warning>

<simpara>

A partir de PHP 8.4.0, depender del valor por omisión de

<parameter>escape</parameter> está deprecado.

Debe ser proporcionado explícitamente ya sea por posición, ya sea mediante

el uso de los <link linkend="functions.named-arguments">argumentos nombrados</link>,

o mediante una llamada a <methodname>SplFileObject::setCsvControl</methodname>.

</simpara>

</warning>

</listitem>

</varlistentry>

</variablelist>

</para>

&warning.csv.escape-parameter;

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve un array indexado que contiene todos los campos leídos, o &false;

si ocurre un error.

</para>

<note>

<para>

Una línea vacía de un archivo CSV será devuelta en forma de un array

contenido un solo campo &null; a menos que se utilice

<constant>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</constant>,

en cuyo caso, las líneas vacías serán ignoradas.

</para>

</note>

</refsect1>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='errors']/.)">

<xi:fallback/>

</xi:include>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.fgetcsv')/db:refsect1[@role='changelog']//db:row[db:entry[text()='8.4.0']]/.)">

<xi:fallback/>

</xi:include>

<row>

<entry>7.4.0</entry>

<entry>

El parámetro <parameter>escape</parameter> ahora acepta una cadena de

caracteres vacía para desactivar el mecanismo de escape propietario.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <methodname>SplFileObject::fgetcsv</methodname></title>

<programlisting role="php">

</programlisting>

</example>

</para>

<para>

<example>

<title>Ejemplo con <constant>SplFileObject::READ_CSV</constant></title>

<programlisting role="php">

</programlisting>

<para>Contenido de animals.csv</para>

<programlisting role="txt">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><methodname>SplFileObject::fputcsv</methodname></member>

<member><methodname>SplFileObject::setCsvControl</methodname></member>

<member><methodname>SplFileObject::getCsvControl</methodname></member>

<member><methodname>SplFileObject::setFlags</methodname></member>

<member><constant>SplFileObject::READ_CSV</constant></member>

<member><methodname>SplFileObject::current</methodname></member>

<member><function>fputcsv</function></member>

<member><function>fgetcsv</function></member>

<member><function>str_getcsv</function></member>

</simplelist>

</refsect1>

</refentry>