ファイルから行を取り出し CSV フィールドとして処理する

# SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7)

SplFileObject::fgetcsv — ファイルから行を取り出し CSV フィールドとして処理する

### 説明

public SplFileObject::fgetcsv ([ string `$delimiter` = "," [, string `$enclosure` = "\"" [, string `$escape` = "\\" ]]] ) : array

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

### パラメータ

`delimiter`

  フィールドの区切り文字 (1 文字のみ)。デフォルトはカンマもしくは SplFileObject::setCsvControl() を使ってセットされた値です。

`enclosure`

  フィールド囲み文字 (1 文字のみ)。デフォルトはダブルクォートもしくは SplFileObject::setCsvControl() を使ってセットされた値です。

`escape`

  エスケープ文字 (1 文字のみ)。デフォルトはバックスラッシュ (\) もしくは SplFileObject::setCsvControl() を使ってセットされた値です。

### 返り値

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

> 注意:

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

### 例

例1 SplFileObject::fgetcsv() の例

`<?php
$file = new SplFileObject("data.csv");
while (!$file->eof()) {
var_dump($file->fgetcsv());
}
?>`

例2 `SplFileObject::READ_CSV` の例

`<?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);
}
?>`

animals.csv の内容

    crocodile,reptile,4
    dolphin,mammal,0
    duck,bird,2
    koala,mammal,4
    salmon,fish,0

上の例の出力は、 たとえば以下のようになります。

    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

### 参考

- SplFileObject::setCsvControl() - CSV の区切り文字、囲み文字、エスケープ文字をセットする
- SplFileObject::setFlags() - SplFileObject のフラグをセットする
- SplFileObject::READ_CSV
- SplFileObject::current() - ファイルの現在の行を取得する