【PHP8.x】SplTempFileObject::fputcsv()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して一時ファイルにCSVデータを書き込み、読み出すサンプル。
5 * 特に、データ内のダブルクォーテーションがfputcsvによって適切にエスケープされる方法を示します。
6 */
7function writeAndReadCsvWithDoubleQuotesExample(): void
8{
9    // SplTempFileObject のインスタンスを作成します。
10    // これはメモリ上に一時ファイルを生成し、ディスクI/Oを回避できます。
11    $csvFile = new SplTempFileObject();
12
13    // CSVとして書き込むデータを用意します。
14    // フィールド内にカンマやダブルクォーテーションを含むデータを含めます。
15    $data = [
16        ['ID', '商品名', '詳細'],
17        [1, 'リンゴ', '青森県産の美味しいリンゴです。'],
18        [2, 'バナナ', '輸入品ですが、"高糖度"で人気です。'], // フィールド内にダブルクォーテーションを含む
19        [3, 'ミカン', '和歌山産、"甘くて"、酸味も控えめです。'], // フィールド内にダブルクォーテーションとカンマを含む
20        [4, 'ブドウ', '"シャインマスカット"は特に人気があります。'], // フィールド全体を囲むダブルクォーテーションの内側にダブルクォーテーション
21    ];
22
23    // 各行を fputcsv を使って一時ファイルに書き込みます。
24    // fputcsv はデフォルトで、フィールドをダブルクォーテーションで囲み、
25    // フィールド内のダブルクォーテーションは二重にしてエスケープします。
26    foreach ($data as $row) {
27        $bytesWritten = $csvFile->fputcsv($row);
28        if ($bytesWritten === false) {
29            echo "エラー: CSV行の書き込みに失敗しました。\n";
30            return;
31        }
32    }
33
34    // ファイルポインタを先頭に戻します。
35    // これにより、書き込んだ内容を最初から読み出すことができます。
36    $csvFile->rewind();
37
38    echo "--- 生成されたCSVの内容 (SplTempFileObjectから読み出し) ---\n";
39
40    // 書き込まれたCSVの内容を1行ずつ読み出し、出力します。
41    while (!$csvFile->eof()) {
42        $line = $csvFile->fgets();
43        if ($line !== false) {
44            echo $line;
45        }
46    }
47    echo "--------------------------------------------------------\n";
48
49    // SplTempFileObject はスクリプト終了時に自動的に破棄されるため、
50    // 明示的なクローズ処理は不要です。
51}
52
53// 関数を実行します。
54writeAndReadCsvWithDoubleQuotesExample();

PHP 8のSplTempFileObject::fputcsvメソッドは、メモリ上の一時ファイルに配列形式のデータをCSVの1行として書き込むための便利な機能です。第一引数には、CSVの各フィールドとなる文字列の配列を指定します。オプションで、区切り文字、フィールドを囲む文字（デフォルトはダブルクォーテーション）、エスケープ文字、行末文字を設定できます。特にこのメソッドはCSVの標準に準拠しており、フィールド内に区切り文字や改行文字、あるいは囲み文字（例えばダブルクォーテーション）自体が含まれる場合、自動的にフィールドを囲み文字で囲み、内部の囲み文字は二重にして適切にエスケープします。これにより、データが破損することなく正確なCSV形式で出力されます。メソッドの実行に成功すると、書き込まれたバイト数が整数で返され、失敗した場合はfalseが返されます。サンプルコードでは、SplTempFileObjectを利用して、データに含まれるダブルクォーテーションがfputcsvによってどのように適切にエスケープされ、CSVとして整形されるかを示しています。一時ファイルへの書き込み後、rewind()でポインタを先頭に戻し、fgets()で内容を読み出すことで、正確なCSV出力が確認できます。この機能は、複雑な文字列を含むCSVデータを効率的かつ安全に作成する際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * SplTempFileObject と fputcsv を使用して、UTF-8 BOM付きのCSVデータを生成する関数。
5 * CSVファイルの文字化けは、特に日本語環境のExcelなどで発生しやすいため、
6 * UTF-8 BOM (Byte Order Mark) を追加することで、多くの場合解決できます。
7 */
8function generateCsvWithBom(): void
9{
10    // SplTempFileObject は、一時的にデータを保持するためのファイルのようなオブジェクトです。
11    // デフォルトではメモリ上で動作し、必要に応じてシステムの一時ファイルに書き出されます。
12    $file = new SplTempFileObject();
13
14    // UTF-8 BOM (バイトオーダーマーク) をファイルの先頭に書き込みます。
15    // これは、ファイルがUTF-8エンコーディングであることを明示し、
16    // 特にMicrosoft Excelなどがファイルを正しく解釈するのに役立ちます。
17    $file->fwrite("\xEF\xBB\xBF");
18
19    // CSVのヘッダー行を定義します。
20    $header = ['ID', '商品名', '価格'];
21
22    // fputcsv を使用してヘッダー行をCSV形式で書き込みます。
23    // fputcsv は配列をCSVの1行としてフォーマットし、ファイルポインタが指す位置に書き込みます。
24    // 戻り値は書き込まれたバイト数、または失敗した場合は false です。
25    $result = $file->fputcsv($header);
26    if ($result === false) {
27        echo "CSVヘッダーの書き込みに失敗しました。\n";
28        return;
29    }
30
31    // CSVのデータ行を定義します。
32    $dataRows = [
33        [1, 'PHP入門書', 2500],
34        [2, 'Web開発ツール', 8000],
35        [3, 'データベース実践ガイド', 3200],
36    ];
37
38    // 各データ行を fputcsv を使用してCSV形式で書き込みます。
39    foreach ($dataRows as $row) {
40        $result = $file->fputcsv($row);
41        if ($result === false) {
42            echo "CSVデータ行の書き込みに失敗しました。\n";
43            return;
44        }
45    }
46
47    // ファイルポインタをファイルの先頭に戻します。
48    // これにより、書き込んだ内容を最初から読み出すことができるようになります。
49    $file->rewind();
50
51    // 生成されたCSVの内容を標準出力に表示します。
52    // 実際のアプリケーションでは、この内容をHTTPレスポンスとしてブラウザに送信し、
53    // CSVファイルをダウンロードさせることが一般的です。
54    echo "--- 生成されたCSVの内容 ---\n";
55    while (!$file->eof()) {
56        echo $file->fgets();
57    }
58    echo "---------------------------\n";
59}
60
61// 関数を実行し、BOM付きCSVの生成と表示を行います。
62generateCsvWithBom();

PHP 8のSplTempFileObject::fputcsvメソッドは、配列データをCSV形式でファイルライクなオブジェクトに書き込む際に利用されます。SplTempFileObjectは、一時的にデータを保持するためのメモリ上または一時ファイルとして機能するオブジェクトで、CSV生成などで一時的なデータ保管に役立ちます。

fputcsvメソッドは、第一引数array $fieldsで指定された配列の要素をCSVの1行として整形し、SplTempFileObjectに書き込みます。区切り文字や囲み文字、エスケープ文字、改行コードはそれぞれstring $separator, string $enclosure, string $escape, string $eolとして変更可能です。書き込みが成功すると書き込まれたバイト数（int）を返し、失敗した場合はfalseを返します。

サンプルコードでは、SplTempFileObjectを生成した後、まずfwriteでUTF-8のBOM（Byte Order Mark）を書き込んでいます。これは、特にMicrosoft Excelなどで日本語CSVを読み込んだ際の文字化けを防ぐための重要な手段です。その後にfputcsvを使ってヘッダーやデータ行をCSV形式で追記します。全ての書き込みが完了したらrewind()でポインタを先頭に戻し、fgets()で内容を読み出して表示することで、BOM付きのCSVデータが正しく生成されていることを確認しています。この方法により、プログラム内で簡単にCSVデータを生成し、文字化けの問題を回避できます。