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

Copy
1<?php
2
3// Define a temporary file name for demonstration
4$filename = 'sample_data_for_fscanf.txt';
5
6// --- Step 1: Create a dummy file with structured data ---
7// This simulates a file that a system engineer might need to parse.
8// Each line contains Name (string), Age (integer), and Score (float), separated by spaces.
9$fileContent = "Alice 30 95.5\n";
10$fileContent .= "Bob 25 88.0\n";
11$fileContent .= "Charlie 22 75.0\n";
12file_put_contents($filename, $fileContent);
13
14echo "--- Reading data from '{$filename}' using SplFileObject::fscanf ---\n";
15
16try {
17    // --- Step 2: Open the file using SplFileObject ---
18    // SplFileObject provides an object-oriented interface for file handling,
19    // extending the functionality of standard file pointers.
20    // 'r' mode opens the file for reading.
21    $file = new SplFileObject($filename, 'r');
22
23    // --- Step 3: Define the format string for fscanf ---
24    // This string tells fscanf how to parse each line of the file.
25    // %s: reads a string (sequence of non-whitespace characters)
26    // %d: reads a decimal integer
27    // %f: reads a floating-point number
28    // Spaces in the format string match any number of whitespace characters in the input.
29    $format = "%s %d %f";
30
31    // --- Step 4: Loop through each line and parse it ---
32    // The loop continues as long as the end of the file has not been reached.
33    while (!$file->eof()) {
34        // Read and parse a line from the file according to the specified format.
35        // SplFileObject::fscanf attempts to read a line, parse it, and returns
36        // an array of the parsed values on success.
37        // It returns `false` if the end of the file is reached or an error occurs during reading.
38        $parsedData = $file->fscanf($format);
39
40        // Check if data was successfully parsed into an array.
41        // `is_array` ensures we have a valid result from parsing before attempting to use it.
42        if (is_array($parsedData)) {
43            // Use array destructuring (available since PHP 7.1) to assign parsed values
44            // to named variables. This makes the code cleaner and more readable.
45            [$name, $age, $score] = $parsedData;
46
47            // Output the parsed information for the current line.
48            echo "Name: {$name}, Age: {$age}, Score: {$score}\n";
49        } elseif ($parsedData === false) {
50            // If fscanf returns false, it typically means the end of the file was reached
51            // after the last line was processed, or a file read error occurred.
52            // We break the loop in this case.
53            break;
54        }
55        // If $parsedData is neither an array nor false (e.g., null, which could happen
56        // if a line doesn't match the format but isn't EOF), we simply skip it.
57        // For our well-structured data, this case is less likely.
58    }
59
60} catch (Exception $e) {
61    // Catch any exceptions that might occur during file operations,
62    // such as the file not being found or permission issues.
63    echo "Error: " . $e->getMessage() . "\n";
64} finally {
65    // --- Step 5: Clean up the temporary file ---
66    // This `finally` block ensures the temporary file is deleted
67    // even if an error occurred during the `try` block.
68    if (file_exists($filename)) {
69        unlink($filename);
70        echo "--- Cleaned up '{$filename}' ---\n";
71    }
72}

PHP 8のSplFileObject::fscanfメソッドは、ファイルから特定の形式で構造化されたデータを効率的に読み込むための機能です。システムエンジニアが設定ファイルやログファイルなど、定型フォーマットのテキストデータを解析する際によく利用されます。

このメソッドは、SplFileObjectクラスのインスタンスを通じて使用され、ファイルポインタが指す位置からデータを読み込みます。引数には、読み込むデータのパターンを定義する$format文字列を指定します。例えば、%sは文字列、%dは整数、%fは浮動小数点数を意味し、これらの指定子を組み合わせることで、一行のデータから複数の異なる型の値を取り出すことができます。

fscanfは、指定されたフォーマットに従って行を解析し、抽出された値を配列として返します。もしファイルの終端に達したり、読み込みエラーが発生したりした場合はfalseを返します。サンプルコードでは、一時ファイルに「名前 歳 点数」という形式でデータを書き込み、SplFileObjectでそのファイルを開いています。そして、"%s %d %f"というフォーマット文字列を使って、各行から名前（文字列）、年齢（整数）、点数（浮動小数点数）を読み取り、それぞれを別の変数に格納して表示しています。データの読み取りが終わると、一時ファイルは自動的に削除され、クリーンアップも適切に行われます。このように、fscanfを使うことで、複雑なパース処理を手軽に実装できます。

Copy
1<?php
2
3/**
4 * 標準入力から名前と年齢を読み込み、表示する関数。
5 * SplFileObject::fscanf を使用して、フォーマットされた入力をパースします。
6 *
7 * システムエンジニアを目指す初心者向け:
8 * このコードは、プログラムがユーザーからの入力を受け取り、
9 * 特定の形式（例: "文字列 整数"）に沿ってそのデータを解析する方法を示しています。
10 * SplFileObject はファイル操作のためのオブジェクトですが、
11 * 'php://stdin' を使うことで標準入力（キーボード入力など）をファイルのように扱えます。
12 * fscanf は、読み込んだ文字列を特定のフォーマットに従って複数のデータに分割するのに便利です。
13 */
14function readNameAndAgeFromStdin(): void
15{
16    echo "名前と年齢を入力してください (例: John 30): ";
17
18    // 標準入力 (stdin) を SplFileObject として開く
19    // 'php://stdin' は標準入力を参照する特殊なパスです。
20    // 'r' は読み込みモードを意味します。
21    $stdin = new SplFileObject('php://stdin', 'r');
22
23    // fscanf を使用して、標準入力からフォーマットされたデータを読み込む
24    // "%s" は文字列を読み込むフォーマット指定子です。
25    // "%d" は符号付き10進数を読み込むフォーマット指定子です。
26    // 読み込みが成功すると、パースされた値が配列として返されます。
27    // 失敗した場合は false が返されます。
28    $data = $stdin->fscanf("%s %d");
29
30    // fscanf の戻り値が false でない（つまり、データが正常に読み込まれた）場合
31    if ($data !== false) {
32        // 読み込まれたデータは配列として返されます。
33        // $data[0] には名前（文字列）、$data[1] には年齢（整数）が入ります。
34        $name = $data[0];
35        $age = $data[1];
36
37        echo "入力されたデータ:\n";
38        echo "名前: " . $name . "\n";
39        echo "年齢: " . $age . "\n";
40    } else {
41        echo "データの読み込みに失敗しました。正しいフォーマットで入力してください。\n";
42    }
43}
44
45// 関数を実行
46readNameAndAgeFromStdin();
47
48?>

このPHPコードは、SplFileObjectクラスのfscanfメソッドを利用して、標準入力（キーボードからの入力など）から特定の形式で入力されたデータを読み込み、処理する方法を示しています。

最初に、new SplFileObject('php://stdin', 'r')と記述することで、標準入力をファイルのように扱えるオブジェクトを作成します。ここで'php://stdin'は標準入力にアクセスするための特別なパスであり、'r'は読み込みモードを指定しています。

次に、$stdin->fscanf("%s %d")を呼び出し、ユーザーが入力した文字列を"%s %d"というフォーマットに沿って解析します。fscanfの第一引数$formatには、入力データの形式を示す文字列を指定します。この例では、%sが文字列、%dが符号付き10進整数をそれぞれ読み込むことを意味します。第二引数以降の...$varsは、参照渡しで直接変数に値を格納する際に使用しますが、このサンプルでは戻り値を利用しています。

fscanfメソッドは、指定されたフォーマットでの読み込みと解析に成功した場合、解析された値を含む配列を返します。もし読み込みや解析に失敗した場合はfalseを返します。コードでは、この戻り値がfalseでないことを確認し、正常にデータが取得できた場合に配列の要素から名前と年齢を取り出して表示しています。この機能は、特定の構造を持つユーザー入力を効率的に取得・処理する際に役立ちます。