(PHP 4, PHP 5, PHP 7, PHP 8)
fgetcsv — ファイルポインタから行を取得し、CSVフィールドを処理する
$stream,$length = null,$separator = ",",$enclosure = "\"",$escape = "\\"fgets() に動作は似ていますが、 fgetcsv() は行を CSV フォーマットのフィールドとして読込み処理を行い、 読み込んだフィールドを含む配列を返すという違いがあります。
注意:
この関数はロケール設定を考慮します。もし 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文字でエスケープすることには、 特別な意味はありません。それ自身をエスケープする意味ですらありません。
読み込んだフィールドの内容を含む数値添字配列を返します。
失敗した場合に false を返します
注意:
CSV ファイルの空行は null フィールドを一つだけ含む配列として返され、 エラーにはなりません。
注意: マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、
PHPが行末を認識できないという問題が発生した場合、 実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれません。
| バージョン | 説明 |
|---|---|
| 8.0.0 |
length は、nullable になりました。
|
| 7.4.0 |
escape パラメータが空文字列を受け入れるようになりました。
この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
|
例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);
}
?>