fgetcsv

(PHP 3 >= 3.0.8, PHP 4, PHP 5)

fgetcsv --  ファイルポインタから行を取得し、CSVフィールドを処理する

説明

array fgetcsv ( resource handle [, int length [, string delimiter [, string enclosure]]] )

handle

ファイルポインタは有効なものでなければならず、また fopen(), popen(), もしくは fsockopen() で正常にオープンされたファイルを指している必要があります。

length (オプション)

(行末文字を考慮して) CSVファイルにある最も長い行よりも大きい 必要があります。 PHP 5 でオプションになりました。このパラメータを省略 (もしくは PHP 5.0.4 かそれ以降で 0 を設定) すると、 最大行長は制限されません。この場合、若干動作が遅くなります。

delimiter (オプション)

フィールドのデリミタ (1 文字のみ) を設定します。 デフォルトはカンマです。

enclosure (オプション)

フィールド囲い子文字 (1 文字のみ) を設定します。 デフォルトはダブルクォーテーションマークです。 PHP 4.3.0 で追加されました。

fgets()に動作は似ていますが、 fgetcsv()は行をCSVフォーマッ トのフィールドとして読込み処理を行い、読み込んだフィールドを含む 配列を返すという違いがあります。

fgetcsv()はファイルの終端に達した場合を含み、 エラー時にFALSEを返します。

CSVファイルの空行はヌルフィールドを一つだけ含む配列として返され、 エラーにはなりません。

例 1. CSV ファイルの全てのコンテンツを読み込み、表示する

<?php
$row
= 1;
$handle = fopen("test.csv", "r");
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);
?>

fgetcsv() は PHP 4.3.5 以降バイナリセーフになりました。

注意: この関数はロケール設定を考慮します。もし LANG が例えば en_US.UTF-8 の場合、 ファイル中の 1 バイトエンコーディングは間違って読み込まれます。

注意: マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、 PHP が行末を認識できないという問題が発生した場合、 実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれません。

explode(), file(), pack(), fputcsv() も参照してください。