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

Copy
1<?php
2
3/**
4 * SplTempFileObject::fscanf メソッドの使用例を示します。
5 * このコードは、一時ファイルにデータを書き込み、fscanf を使用して
6 * フォーマットに従ってデータを読み込む基本的な流れを、初心者にも理解しやすいように提示します。
7 */
8function demonstrateSplTempFileObjectFscanF(): void
9{
10    // SplTempFileObject のインスタンスを作成します。
11    // これはメモリ上に一時的なファイルを作成し、通常のファイルと同様の操作を可能にします。
12    $tempFile = new SplTempFileObject();
13
14    // 読み込みたいデータを一時ファイルに書き込みます。
15    // fscanf で解析しやすいように、カンマ区切り（CSV形式）の文字列を使用します。
16    $tempFile->fwrite("Alice, 30, Engineer\n");
17    $tempFile->fwrite("Bob, 25, Designer\n");
18    $tempFile->fwrite("Charlie, 35, Manager\n");
19
20    // ファイルポインタをファイルの先頭に戻します。
21    // これにより、書き込んだデータの最初から読み込みを開始できます。
22    $tempFile->rewind();
23
24    echo "--- SplTempFileObject::fscanf によるデータ読み込み ---" . PHP_EOL;
25
26    // ループを使って、ファイルからデータを1行ずつ読み込み、解析します。
27    // fscanf は指定されたフォーマット文字列に従って行を解析し、配列を返します。
28    // ファイルの終端に達するか、読み込みに失敗すると false を返します。
29    //
30    // フォーマット文字列 "%[^,], %d, %s\n" の説明:
31    // - %[^,] : カンマ (,) 以外の文字のシーケンスを読み込みます (例: "Alice")。
32    // - ,     : リテラルなカンマ文字にマッチします。
33    // - %d    : 符号付きの十進整数を読み込みます (例: "30")。
34    // - ,     : リテラルなカンマ文字にマッチします。
35    // - %s    : 空白文字までの一連の文字列を読み込みます (例: "Engineer")。
36    // - \n    : 改行文字にマッチします。
37    while (false !== ($data = $tempFile->fscanf("%[^,], %d, %s\n"))) {
38        // fscanf が成功した場合、$data は解析された値を含む配列になります。
39        echo sprintf("名前: %s, 年齢: %d, 職業: %s" . PHP_EOL, $data[0], $data[1], $data[2]);
40    }
41
42    echo "--- 読み込み完了 ---" . PHP_EOL;
43}
44
45// 関数を実行し、SplTempFileObject::fscanf の動作を確認します。
46demonstrateSplTempFileObjectFscanF();

このサンプルコードは、PHP 8 の SplTempFileObject クラスに属する fscanf メソッドの基本的な使用方法を示しています。SplTempFileObject は、メモリ上またはディスク上に一時的なファイルを作成し、通常のファイルと同様にファイル操作を行えるオブジェクトです。

まず、このオブジェクトを使って一時ファイルに「Alice, 30, Engineer」のようなカンマ区切りの文字列データを複数行書き込みます。その後、rewind() メソッドでファイルポインタをファイルの先頭に戻し、書き込んだデータの最初から読み込みを開始できるように準備します。

fscanf メソッドは、ファイルのストリームから指定されたフォーマットに従ってデータを読み込むために使用されます。第一引数 $format には、読み取りたいデータの形式を定義する文字列を指定します。例えば、"%[^,], %d, %s\n" というフォーマットは、「カンマ以外の文字列、整数、文字列」という並びでデータを解析し、改行で区切ることを指示しています。

fscanf は、読み込みに成功した場合、解析された各項目を要素とする配列を返します。読み込みがファイルの終端に達したり、途中で失敗したりした場合は false を返します。サンプルコードでは、この false が返されるまでループを続け、1行ずつデータを読み込み、名前、年齢、職業として整形して出力しています。これにより、CSVのような構造化されたテキストデータを効率的に解析できることを確認できます。

Copy
1<?php
2
3/**
4 * SplTempFileObject::fscanf の使用例
5 *
6 * この関数は SplTempFileObject を使用して、一時ファイルに書き込まれたデータを
7 * フォーマットに従って読み取る方法を示します。
8 * `fscanf` は通常、標準入力 (コンソールからの入力) やファイルから
9 * フォーマットされたデータを読み取る際に使用されます。ここでは、一時ファイルに
10 * サンプルデータを書き込み、それを`fscanf`で読み取ることで、その動作をデモンストレーションします。
11 */
12function processSplTempFileWithFscanf(): void
13{
14    echo "SplTempFileObject::fscanf のデモンストレーション\n";
15    echo "一時ファイルにデータを書き込み、その後 fscanf で読み取ります。\n\n";
16
17    // 1. SplTempFileObject を作成する
18    // SplTempFileObject は、一時ファイルを表すオブジェクトです。
19    // デフォルトではメモリ内に作成され、スクリプト終了時に自動的に削除されます。
20    $tempFile = new SplTempFileObject();
21
22    // 2. 一時ファイルにサンプルデータを書き込む
23    // ここで書き込むデータは、`fscanf`が処理する「入力」の例と見なせます。
24    $dataToWrite = [
25        "10 apple",
26        "20 banana",
27        "this is an invalid line", // この行は fscanf のフォーマットに一致しません
28        "30 orange",
29        "40 grape",
30    ];
31
32    foreach ($dataToWrite as $line) {
33        $tempFile->fwrite($line . "\n");
34        echo "一時ファイルに書き込み: '" . $line . "'\n";
35    }
36
37    echo "\n一時ファイルへの書き込み完了。\n";
38
39    // 3. ファイルポインタを先頭に戻す
40    // `fscanf` でデータを読み取る前に、ファイルポインタをファイルの先頭に設定する必要があります。
41    // `fwrite` によってポインタはファイルの終端に移動しています。
42    $tempFile->rewind();
43    echo "ファイルポインタを先頭にリセットしました。\n\n";
44
45    echo "fscanf を使用して一時ファイルからデータを読み取ります:\n";
46    echo "--------------------------------------------------\n";
47
48    // 4. fscanf を使用して一時ファイルからデータを読み取る
49    // `fscanf(string $format)` は、現在のファイルポインタの位置からデータを読み取り、
50    // 指定されたフォーマットに従って解析します。
51    // "%d %s" は、「整数1つ、スペース、文字列1つ」というフォーマットで読み取ることを意味します。
52    // fscanf は、フォーマットに一致した項目を配列として返します。
53    // ファイルの終端に達するか、読み取りエラーが発生すると false を返します。
54    $lineNum = 1;
55    while (($result = $tempFile->fscanf("%d %s")) !== false) {
56        echo "処理中の行 " . $lineNum . ": ";
57        if (empty($result)) {
58            // `fscanf` が空の配列を返す場合、指定されたフォーマットに一致するデータが
59            // 見つからなかったことを意味します。
60            echo "この行は指定されたフォーマットに一致しませんでした。\n";
61        } else {
62            // フォーマットに一致する項目が見つかった場合
63            echo "正常に解析されました。\n";
64            echo "  - 数量 (int): " . ($result[0] ?? 'N/A') . "\n";
65            echo "  - アイテム (string): " . ($result[1] ?? 'N/A') . "\n";
66        }
67        $lineNum++;
68    }
69
70    echo "--------------------------------------------------\n";
71    echo "一時ファイルからの読み取り完了。\n";
72}
73
74// 関数の実行
75processSplTempFileWithFscanf();

SplTempFileObject::fscanfは、PHPで一時ファイルオブジェクトから特定のフォーマットに従ってデータを読み取るためのメソッドです。一時ファイルは通常、メモリ上に作成され、スクリプト終了時に自動的に削除されるため、一時的なデータ処理に適しています。このfscanfメソッドは、一般的なファイルやキーボードからの標準入力（stdin）から、整形されたデータを読み取る際にも利用される汎用的な機能です。

引数である$formatには、読み取りたいデータの形式を文字列で指定します。例えば、"%d %s"と指定すると、「整数1つ、スペース、文字列1つ」という形式でデータを解析するよう指示できます。戻り値は、フォーマットに一致して正常に解析された項目が配列として返されます。また、ファイル終端に達したり、読み取りエラーが発生した場合はfalseを返します。特定の引数に変数を渡す形式で使用した場合は、代入された引数の数を整数で返すこともあります。

このサンプルコードでは、まずSplTempFileObjectを作成し、そこに複数のテキスト行を書き込みます。その後、rewind()メソッドでファイルポインタを先頭に戻し、fscanf()をループで呼び出して一行ずつデータを読み取っています。フォーマットに合致しない行は解析されずにスキップされるため、データクレンジングのような場面でも活用できます。これにより、一時ファイルに保存された様々な形式のデータを効率的に抽出・処理することが可能です。