fgetcsv
ファイルポインタから行を取得し、CSVフィールドを処理する
説明
arrayfalse fgetcsv(
resource $stream,
intnull $length = null,
string $separator = ",",
string $enclosure = "\"",
string $escape = "\\"
)
注意:
この関数はロケール設定を考慮します。もし LC_CTYPE
が例えば en_US.UTF-8 の場合、
1 バイトエンコーディングのファイルは間違って読み込まれるかもしれません。
パラメータ
-
stream
-
ファイルポインタは有効なものでなければならず、また
fopen,
popen, もしくは fsockopen
で正常にオープンされたファイルを指している必要があります。
-
length
-
(行末文字を考慮して) CSV
ファイルにある最も長い行よりも大きい必要があります。
そうでない場合は、ひとつの行が length
文字ずつのチャンクに分割されてしまいます。
ただし、フィールド囲いこみ文字の内部では、この分割は発生しません。
このパラメータを省略 (もしくは 0 を設定、
PHP 8.0.0 以降では null を設定) すると、
最大行長は制限されません。この場合、若干動作が遅くなります。
-
separator
-
オプションの separator パラメータで、フィールドのデリミタ (シングルバイト文字 1 文字のみ) を設定します。
-
enclosure
-
オプションの enclosure パラメータで、フィールド囲いこみ文字 (シングルバイト文字 1 文字のみ) を設定します。
-
escape
-
オプションの escape パラメータで、エスケープ文字 (シングルバイト文字 最大で1文字) を設定します。
空文字列("") を指定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
注意:
enclosure の文字は、フィールド内で2回出力される
ことでエスケープされます。しかし、
escape 文字はその代替として使えます。
デフォルトのパラメータの値
"" と \" は同じ意味を持ちます。
enclosure の文字を
escape 文字でエスケープすることには、
特別な意味はありません。それ自身をエスケープする意味ですらありません。
警告
escape
が空の文字列("")以外に設定されているとき、
» RFC 4180
に準拠しない CSV が生成されたり、PHP の CSV
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
escapeのデフォルト値は"\\"
なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0
以降の将来のバージョンで変更予定です。
戻り値
読み込んだフィールドの内容を含む数値添字配列を返します。
失敗した場合に false を返します
注意:
CSV ファイルの空行は null
フィールドを一つだけ含む配列として返され、
エラーにはなりません。
注意:
マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、
PHP が行末を認識できないという問題が発生した場合、
実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれません。
例
例1 CSV ファイルの全てのコンテンツを読み込み、表示する
<?php
$row = 1;
if (($handle = fopen("test.csv", "r")) !== FALSE) {
while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
$num = count($data);
echo "<p> $num fields in line $row: <br /></p>\n";
$row++;
for ($c=0; $c < $num; $c++) {
echo $data[$c] . "<br />\n";
}
}
fclose($handle);
}
?>
参考
- str_getcsv
- explode
- file
- pack
- fputcsv