<?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>Récupère une ligne depuis le fichier et l'analyse comme étant des données 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>

Récupère une ligne depuis le fichier et l'analyse comme étant des données <acronym>CSV</acronym>

et retourne un tableau contenant tous les champs lus.

</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>

Le délimiteur de champ (un seul caractère sur un octet).

Par défaut, <literal>,</literal> ou la valeur définie par un appel précédent à

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

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Le caractère utilisé pour entourer la valeur d'un champ (un caractère d'un seul octet).

Par défaut, ce sera un guillemet double ou bien la valeur définie en utilisant

la méthode <methodname>SplFileObject::setCsvControl</methodname>.

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Le caractère d'échappement (un seul caractère sur un octet).

Par défaut, <literal>\</literal> ou la valeur définie par un appel précédent à

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

Une &string; vide (<literal>""</literal>) désactive le mécanisme d'échappement propriétaire.

</para>

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

<warning>

<simpara>

À partir de PHP 8.4.0, dépendre de la valeur par défaut de

<parameter>escape</parameter> est obsolète.

Elle doit être fournie explicitement soit par position, soit par l'utilisation

des <link linkend="functions.named-arguments">arguments nommés</link>,

ou par un appel à <methodname>SplFileObject::setCsvControl</methodname>.

</simpara>

</warning>

</listitem>

</varlistentry>

</variablelist>

</para>

&warning.csv.escape-parameter;

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne un tableau indexé contenant tous les champs lus, ou &false;

si une erreur survient.

</para>

<note>

<para>

Une ligne vide d'un fichier CSV sera retournée sous la forme d'un tableau

contenant un seul champ &null; sauf lors de l'utilisation de

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

auquel cas, les lignes vides seront ignorées.

</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>

Le paramètre <parameter>escape</parameter> accepte désormais une chaîne de

caractères vide afin de désactiver le mécanisme d'échappement propriétaire.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <methodname>SplFileObject::fgetcsv</methodname></title>

<programlisting role="php">

</programlisting>

</example>

</para>

<para>

<example>

<title>Exemple avec <constant>SplFileObject::READ_CSV</constant></title>

<programlisting role="php">

</programlisting>

<para>Contenu d'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>