<?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>ファイルから行を取り出し 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>

<acronym>CSV</acronym> フォーマットのファイルから行を取り出し読み込まれたフィールドを含む配列を返します。

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

フィールドの区切り文字 (シングルバイト文字 1 文字のみ)。

デフォルトはカンマ(<literal>,</literal>)、 もしくは事前に

<methodname>SplFileObject::setCsvControl</methodname> を呼び出してセットされた値です。

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

フィールド囲み文字 (シングルバイト文字 1 文字のみ)。

デフォルトはダブルクォート(<literal>"</literal>)、もしくは事前に

<methodname>SplFileObject::setCsvControl</methodname> を呼び出してセットされた値です。

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

エスケープ文字 (シングルバイト文字 最大で1文字)。

デフォルトはバックスラッシュ(<literal>\</literal>)、 もしくは事前に

<methodname>SplFileObject::setCsvControl</methodname> を呼び出してセットされた値です。

空文字列(<literal>""</literal>)の場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

</para>

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

<warning>

<simpara>

PHP 8.4.0 以降では、<parameter>escape</parameter>

のデフォルト値に依存することは非推奨となりました。

位置指定の引数か、<link linkend="functions.named-arguments">名前付き引数</link>を使用するか、

あるいは <methodname>SplFileObject::setCsvControl</methodname>

を呼び出して、明示的に指定する必要があります。

</simpara>

</warning>

</listitem>

</varlistentry>

</variablelist>

</para>

&warning.csv.escape-parameter;

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

読み込まれたフィールドを含む数値添字配列もしくはエラーのときは &false; を返します。

</para>

<note>

<para>

CSV ファイルの空白行は <constant>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</constant> を使わない限り単独の &null; フィールドで構成される配列として返され、この場合空白行は読み飛ばされます。

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

<parameter>escape</parameter> パラメータは空文字列を受け入れるようになりました。

この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><methodname>SplFileObject::fgetcsv</methodname> の例</title>

<programlisting role="php">

</programlisting>

</example>

</para>

<para>

<example>

<title><constant>SplFileObject::READ_CSV</constant> の例</title>

<programlisting role="php">

</programlisting>

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