SplFileObject::fgetcsv
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fgetcsv — ファイルから行を取り出し CSV フィールドとして処理する
説明
$separator = ",", string $enclosure = "\"", string $escape = "\\"): array|falseCSV フォーマットのファイルから行を取り出し読み込まれたフィールドを含む配列を返します。
注意:
この関数は、ロケール設定を考慮します。
LC_CTYPEがたとえばen_US.UTF-8だった場合、 ファイルの1バイトのエンコーディングは、この関数では間違った読まれ方をする可能性があります。
パラメータ
separator-
フィールドの区切り文字 (シングルバイト文字 1 文字のみ)。 デフォルトはカンマもしくは SplFileObject::setCsvControl() を使ってセットされた値です。
enclosure-
フィールド囲み文字 (シングルバイト文字 1 文字のみ)。 デフォルトはダブルクォートもしくは SplFileObject::setCsvControl() を使ってセットされた値です。
escape-
エスケープ文字 (シングルバイト文字 最大で1文字)。 デフォルトはバックスラッシュ (
\) もしくは SplFileObject::setCsvControl() を使ってセットされた値です。 空文字列("")の場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。注意:
enclosureの文字は、フィールド内で2回出力される ことでエスケープされます。しかし、escape文字はその代替として使えます。 デフォルトのパラメータの値""と\"は同じ意味を持ちます。enclosureの文字をescape文字でエスケープすることには、 特別な意味はありません。それ自身をエスケープする意味ですらありません。
escape
が空の文字列("")以外に設定されているとき、
» RFC 4180
に準拠しない CSV が生成されたり、PHP の CSV
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
escapeのデフォルト値は"\\"
なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0
以降の将来のバージョンで変更予定です。
戻り値
読み込まれたフィールドを含む数値添字配列もしくはエラーのときは false を返します。
注意:
CSV ファイルの空白行は
SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINEを使わない限り単独のnullフィールドで構成される配列として返され、この場合空白行は読み飛ばされます。
変更履歴
| バージョン | 説明 |
|---|---|
| 7.4.0 |
escape パラメータは空文字列を受け入れるようになりました。
この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
|
例
例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() - ファイルの現在の行を取得する
User Contributed Notes 6 notes
Be aware.
There is bug 46569 persists that breaks usage of SplFileObject::fgetcsv() after SplFileObject::seek()-ing to a non-zero position and then returns the contents of wrong line - off by one
<?php
$file = new SplFileObject('foo/bar.csv');
$file->seek(1);
print_r($file->fgetcsv()); // reads 3rd line against 2ndNot that this may return NULL instead of FALSE depending on the given SplFileObject flags in versions prior to PHP 8.1.
Change: https://github.com/php/php-src/commit/188b1d4c7c7b3482584e248522d94e06ba616a1c
Testcase: https://3v4l.org/6dQTTIf your CSV doesn't have enclosures, you can face an issue with default " identified as enclosure in data. Empty $enclosure is not allowed, but you can use same $enclosure as $delimiter (\n by default) to emulate empty enclosure.after setting the delimiter '\t' fgetcsv() truncates the value when it is empty string
workaround:
<?php
$file = new SplFileObject($path);
$file->setFlags(SplFileObject::DROP_NEW_LINE);
while ($file->valid()) {
$line = $file->fgets();
$line = explode("\t", $line);
print_r($line);
}
?>Note that due to bugs 55807 and 61032, introduced in 5.3.8, if the csv in example #2 has a newline character at the end of each line, the foreach will execute 6 times.
The last time through the loop $row will be bool(false). This is true even if using SplFileObject::SKIP_EMPTY and SplFileObject::DROP_NEW_LINE.
Until the bug is fixed, the workaround is to also add SplFileObject::READ_AHEAD to your setFlags() call.