【PHP8.x】fscanf関数の使い方

Copy
1<?php
2
3/**
4 * ファイルからユーザーデータを読み込み、表示するサンプル関数。
5 * fscanf関数を使用して、指定されたフォーマットでファイルからデータを解析します。
6 * この例では、一時的なメモリファイルにサンプルデータを書き込み、そこから読み込みます。
7 */
8function readUserDataFromFile(): void
9{
10    // 一時的なメモリファイルを作成します。これにより、実際のファイルシステムに影響を与えずにテストできます。
11    // 'r+' モードは読み書きを可能にし、ファイルが存在しない場合は作成を試みます。
12    $tempFile = fopen('php://memory', 'r+');
13    if (!$tempFile) {
14        echo "エラー: 一時ファイルの作成に失敗しました。\n";
15        return;
16    }
17
18    // サンプルデータを一時ファイルに書き込みます。
19    // 各行は「名前,年齢,身長」のCSV形式です。
20    fwrite($tempFile, "Alice,30,165.5\n");
21    fwrite($tempFile, "Bob,25,178.0\n");
22    fwrite($tempFile, "Charlie,35,170.2\n");
23    fwrite($tempFile, "David,40,180.0\n");
24
25    // ファイルポインタをファイルの先頭に戻します。
26    // これにより、書き込んだデータがfscanfで読み込み可能になります。
27    fseek($tempFile, 0);
28
29    echo "ファイルからユーザーデータを読み込み、解析します。\n";
30    echo "---------------------------------------------------\n";
31
32    // fscanf用のフォーマット文字列を定義します。
33    // %[^,] : カンマ以外の文字を読み込みます (名前)
34    // %d    : 整数を読み込みます (年齢)
35    // %f    : 浮動小数点数を読み込みます (身長)
36    $format = "%[^,],%d,%f";
37
38    // ファイルの終わり(EOF)に達するか、fscanfがfalse(エラー)またはnull(EOF)を返すまでループします。
39    while (($userData = fscanf($tempFile, $format)) !== false && $userData !== null) {
40        // fscanfが成功した場合、読み込んだデータは配列として返されます。
41        // 配列の要素数が期待通りか確認します。
42        if (is_array($userData) && count($userData) === 3) {
43            echo "名前: " . $userData[0] . ", ";
44            echo "年齢: " . $userData[1] . ", ";
45            echo "身長: " . $userData[2] . "\n";
46        } else {
47            // フォーマットに一致しない行があった場合の処理
48            echo "警告: フォーマットに一致しないデータが見つかりました。\n";
49        }
50    }
51
52    // 開いたファイルを閉じます。
53    fclose($tempFile);
54
55    echo "---------------------------------------------------\n";
56    echo "データの読み込みが完了しました。\n";
57}
58
59// 関数を実行します。
60readUserDataFromFile();
61
62?>

PHPのfscanf関数は、ファイルから指定した書式（フォーマット）に従ってデータを読み込むための関数です。このサンプルコードでは、メモリ上に作成した一時ファイルから、CSV形式のユーザーデータを1行ずつ解析しています。

第1引数にはfopen関数などで開いたファイルポインタを渡し、どのファイルからデータを読み込むかを指定します。第2引数には、データの書式を定義する文字列を指定します。この例の"%[^,],%d,%f"という書式は、「カンマ以外の文字列」「整数」「浮動小数点数」がこの順でカンマ区切りになっているデータ行を読み込むことを意味します。

PHP 8.0以降、fscanf関数は読み込みに成功すると、取得した値を格納した配列を返します。サンプルでは、この配列を受け取って各データを表示しています。ファイルの終端に達するとnullを、エラーの場合はfalseを返すため、whileループと組み合わせることでファイルの最後まで安全にデータを読み進めることができます。このように、fscanf関数は特定の構造を持つテキストファイルからデータを効率的に抽出する際に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 標準入力(STDIN)から fscanf を使用してデータを読み取るサンプルです。
7 *
8 * このスクリプトをコマンドラインで実行し、
9 * 名前と年齢をスペースで区切って入力してからEnterキーを押してください。
10 * (例: Taro 25)
11 */
12function readFormattedInputFromStdin(): void
13{
14    // ユーザーに入力を促すメッセージを表示します。
15    echo "名前と年齢をスペース区切りで入力してください (例: Taro 25): ";
16
17    // 変数を初期化します。
18    $name = null;
19    $age = null;
20
21    // 標準入力ストリーム(STDIN)からフォーマット指定でデータを読み取ります。
22    // "%s %d" は「文字列、スペース、整数」という形式を示します。
23    // 読み取られた値は、第3引数以降で渡した変数に格納されます。
24    $assignedCount = fscanf(STDIN, "%s %d", $name, $age);
25
26    // fscanfは正常に読み込み、変数に代入できた項目の数を返します。
27    // 今回は名前と年齢の2項目が読み込めることを期待しています。
28    if ($assignedCount === 2) {
29        // 読み取ったデータを使用してメッセージを出力します。
30        printf("こんにちは、%sさん！ あなたは%d歳ですね。\n", $name, $age);
31    } else {
32        // 入力が期待したフォーマットと異なっていた場合のエラーメッセージです。
33        fwrite(STDERR, "エラー: 入力形式が正しくありません。\n");
34    }
35}
36
37// 関数を実行します。
38readFormattedInputFromStdin();

fscanf関数は、ファイルポインタや標準入力などのストリームから、指定した書式（フォーマット）に従ってデータを読み取るための関数です。このサンプルコードは、コマンドラインでユーザーがキーボードから入力した名前と年齢をfscanf関数を使って受け取る処理を示しています。

fscanf関数の第1引数には、データの読み取り元となるストリームを指定します。ここではSTDINが指定されており、これは「標準入力」、つまりキーボードからの入力を意味します。

第2引数の"%s %d"は、入力データの書式を指定する文字列です。%sは任意の文字列、%dは10進数の整数を表しており、「文字列、スペース、整数」という形式のデータを期待していることを示します。

第3引数以降には、読み取ったデータを格納するための変数を指定します。サンプルでは、書式%sで読み取った文字列が変数$nameに、%dで読み取った整数が変数$ageにそれぞれ代入されます。

この関数の戻り値は、書式に従って正常に読み込み、変数に代入できた項目の数です。サンプルでは、名前と年齢の2項目が正しく代入されることを期待しているため、戻り値が2であるかどうかを確認し、入力が正しい形式であったかを判断しています。もし入力が期待した形式でなかった場合、戻り値は2未満となり、エラーメッセージが表示されます。