【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
3/**
4 * PHPのfscanf関数を使用して、ファイルからフォーマットされたデータを読み込むサンプルです。
5 * システムエンジニアを目指す初心者向けに、基本的なファイル入出力のプロセスを示します。
6 */
7
8// 1. サンプルデータファイルを作成します。
9// このファイルは、fscanf関数が読み込むデータ源となります。
10$filename = 'data.txt';
11$fileContent = "Alice 30\nBob 25\nCharlie 35\n"; // 名前と年齢の形式
12file_put_contents($filename, $fileContent);
13
14echo "--- ファイル '{$filename}' からデータを読み込みます ---\n";
15
16// 2. 作成したファイルを読み込みモード ('r') で開きます。
17// fopen関数は、成功するとファイルリソース（ハンドル）を、失敗すると false を返します。
18$fileHandle = fopen($filename, 'r');
19
20// 3. ファイルが正常に開かれたかを確認します。
21if ($fileHandle === false) {
22    echo "エラー: ファイル '{$filename}' を開けませんでした。\n";
23    exit(1); // スクリプトを終了します。
24}
25
26// 4. ファイルの終端までループし、fscanf関数でデータを読み込みます。
27// fscanf(ストリーム, フォーマット文字列, ...変数)
28// - $fileHandle: 開かれたファイルのリソース。
29// - "%s %d": フォーマット文字列。
30//   - %s: 文字列を読み込みます (名前)。
31//   - %d: 10進数整数を読み込みます (年齢)。
32// fscanfは、指定されたフォーマットでデータを読み込み、成功すると配列を返します。
33// 読み込むデータがもうない場合やエラーの場合は、false または null を返します (PHP 8以降)。
34while (true) {
35    $data = fscanf($fileHandle, "%s %d");
36
37    // 読み込むデータがなくなったか、エラーが発生した場合
38    if ($data === false || $data === null) {
39        break; // ループを終了します。
40    }
41
42    // 読み込んだデータは配列として取得されます。
43    // 配列の0番目に名前、1番目に年齢が格納されます。
44    $name = $data[0] ?? 'N/A'; // 名前が取得できなかった場合のデフォルト値
45    $age = $data[1] ?? 'N/A';  // 年齢が取得できなかった場合のデフォルト値
46
47    echo "名前: {$name}, 年齢: {$age}\n";
48}
49
50// 5. ファイル操作が完了したら、ファイルを閉じます。
51// fclose関数は、開いたファイルリソースを解放します。
52fclose($fileHandle);
53
54echo "--- データの読み込みが完了しました ---\n";
55
56// 6. サンプルとして作成した一時ファイルを削除します。
57// unlink関数はファイルを削除します。
58unlink($filename);
59
60?>

PHPのfscanf関数は、ファイルから特定のフォーマットに従ってデータを読み込む際に使用されます。このサンプルコードでは、まず一時的なデータファイルを作成し、そのファイルから名前（文字列）と年齢（整数）の形式でデータを読み込む一連の流れを示しています。

fscanf関数は、fopen関数で開かれたファイルリソース（$stream）と、読み込むデータの形式を定義するフォーマット文字列（string $format）を必須の引数として受け取ります。例えば、"%s %d"というフォーマットは、「文字列の後にスペース、そして整数」という形式のデータを読み込むことを意味します。ここで%sは文字列を、%dは10進数整数を読み込む指示です。

関数が成功すると、読み込んだデータが格納された配列が戻り値として返されます。この配列の要素は、フォーマット文字列で指定した順序でデータを含みます。ファイル終端に到達した場合や読み込みエラーが発生した場合は、falseまたはnullが返されるため、これを利用してデータ読み込みの終了を判断します。

本サンプルでは、ファイルを開き、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未満となり、エラーメッセージが表示されます。