SplFileObject::fgetcsv
(PHP 5 >= 5.1.0, PHP 7)
SplFileObject::fgetcsv — ファイルから行を取り出し CSV フィールドとして処理する
説明
public SplFileObject::fgetcsv
([ string $delimiter = ","
[, string $enclosure = "\""
[, string $escape = "\\"
]]] ) : array
CSV フォーマットのファイルから行を取り出し読み込まれたフィールドを含む配列を返します。
注意:
この関数は、ロケール設定を考慮します。
LC_CTYPEがたとえばen_US.UTF-8だった場合、 ファイルの1バイトのエンコーディングは、この関数では間違った読まれ方をする可能性があります。
パラメータ
delimiterフィールドの区切り文字 (1 文字のみ)。デフォルトはカンマもしくは SplFileObject::setCsvControl() を使ってセットされた値です。
enclosureフィールド囲み文字 (1 文字のみ)。デフォルトはダブルクォートもしくは SplFileObject::setCsvControl() を使ってセットされた値です。
escapeエスケープ文字 (最大で1文字)。デフォルトはバックスラッシュ (
\) もしくは SplFileObject::setCsvControl() を使ってセットされた値です。 空文字列("")の場合、プロプライエタリなエスケープ機構が無効になります。注意:
enclosureの文字は、フィールド内で2回出力される ことでエスケープされます。しかし、escape文字はその代替として使えます。 デフォルトのパラメータの値""と\"は同じ意味を持ちます。enclosureの文字をescape文字でエスケープすることには、 特別な意味はありません。それ自身をエスケープする意味ですらありません。
返り値
読み込まれたフィールドを含む数値添字配列もしくはエラーのときは false を返します。
注意:
CSV ファイルの空白行は
SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINEを使わない限り単独のnullフィールドで構成される配列として返され、この場合空白行は読み飛ばされます。
変更履歴
| バージョン | 説明 |
|---|---|
| 7.4.0 | escape パラメータは空文字列を受け入れるようになりました。
この場合、プロプライエタリなエスケープ機構が無効になります。 |
例
例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() - ファイルの現在の行を取得する
