PHPKonf Istanbul PHP Conference 2019 - Call for Papers

SplFileObject::fgetcsv

(PHP 5 >= 5.1.0, PHP 7)

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

説明

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

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

参考

add a note add a note

User Contributed Notes 3 notes

up
4
vaughn dot clayton+php at servicetrade dot com
6 years ago
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.
up
1
v-fpiris at teknober dot com
7 years ago
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);
}
?>
up
0
Denitz
2 months ago
If 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.
To Top