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

Copy
1<?php
2
3/**
4 * 標準入力 (stdin) から行を読み込み、画面に出力する関数。
5 *
6 * SplFileObject::fgets メソッドを使用して、標準入力から一行ずつデータを読み込みます。
7 * ユーザーが Ctrl+D (Unix/Linux/macOS) または Ctrl+Z (Windows) を押して入力を終了するまで、
8 * 入力された行を表示し続けます。
9 */
10function readFromStdinUsingSplFileObject(): void
11{
12    echo "何か入力してください（Ctrl+D または Ctrl+Z で入力を終了）:\n";
13
14    try {
15        // 'php://stdin' は、PHPで標準入力にアクセスするための特別なラッパーです。
16        // SplFileObject を使用することで、標準入力をファイルオブジェクトとして操作できます。
17        // 'r' モードは読み込み専用を意味します。
18        $stdin = new SplFileObject('php://stdin', 'r');
19
20        // 標準入力の終端 (EOF) に達するまで、一行ずつデータを読み込みます。
21        // fgets() は読み込んだ文字列（改行文字を含む）を返すか、
22        // ファイル終端に達した場合やエラーが発生した場合に false を返します。
23        while (($line = $stdin->fgets()) !== false) {
24            // 読み込んだ行を出力します。
25            // fgets() は行末の改行文字も含むため、echo でそのまま出力しても改行されます。
26            echo "入力された行: " . $line;
27        }
28
29        echo "入力の読み込みが終了しました。\n";
30
31    } catch (Exception $e) {
32        // SplFileObject の操作中に例外が発生した場合、エラーメッセージを出力します。
33        echo "エラーが発生しました: " . $e->getMessage() . "\n";
34    }
35}
36
37// 上記の関数を実行し、標準入力からの読み込みを開始します。
38readFromStdinUsingSplFileObject();
39

PHP 8のSplFileObject::fgetsメソッドは、ファイルオブジェクトからデータを一行ずつ読み込むための機能を提供します。このメソッドは引数を必要とせず、ファイルから読み込んだ文字列（改行文字を含む）を返すか、ファイルの終端に達した場合やエラーが発生した場合にはfalseを返します。

このサンプルコードでは、php://stdinという特別な指定子を利用して、標準入力（通常はキーボードからの入力）をSplFileObjectとして扱っています。まず、new SplFileObject('php://stdin', 'r')によって標準入力を読み込み専用のファイルオブジェクトとして開きます。

次に、whileループ内で$stdin->fgets()を繰り返し呼び出しています。これにより、ユーザーが何か入力しEnterキーを押すたびに、その一行分のデータが$line変数に格納され、echoで画面に出力されます。fgets()は読み込んだ行の最後に改行文字も含むため、出力時に自動的に改行されます。ユーザーが入力の終了を示すCtrl+D（Unix/Linux/macOS）またはCtrl+Z（Windows）を押すと、fgets()はfalseを返すため、ループが終了し、プログラムは標準入力からの読み込みを終えます。この機能を使うことで、ファイルだけでなく、キーボードからの対話的な入力も柔軟に処理することが可能です。

Copy
1<?php
2
3/**
4 * SplFileObject::fgets メソッドの使用例。
5 * ファイルから1行ずつ読み込み、特に改行コードの扱いを示します。
6 *
7 * fgets は行末の改行コード（例: \n, \r\n）を含めて行を読み込みます。
8 * 改行コードを除去したい場合は、trim() 関数などを使用します。
9 */
10function demonstrateFgetsWithNewlineHandling(): void
11{
12    // 1. 読み込むためのテストファイルを準備
13    // システムの一時ディレクトリにユニークな名前でファイルを作成します。
14    $tempFileName = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'sample_php_data_' . uniqid() . '.txt';
15    $fileContent = "Hello PHP!\nThis is the second line.\r\nAnd this is the last line without a final newline.";
16
17    // ファイルにテスト内容を書き込みます。
18    // file_put_contents は指定されたファイルにデータを書き込むPHP関数です。
19    if (file_put_contents($tempFileName, $fileContent) === false) {
20        echo "エラー: テストファイルの作成に失敗しました。\n";
21        return;
22    }
23
24    echo "--- ファイル内容の読み込み開始 ---\n";
25
26    try {
27        // 2. SplFileObject を使用してファイルを読み取りモード ('r') で開きます。
28        // SplFileObject は、ファイル操作をオブジェクト指向で扱うためのPHPクラスです。
29        $file = new SplFileObject($tempFileName, 'r');
30
31        $lineNumber = 1;
32        // 3. fgets メソッドを使用してファイルから1行ずつ読み込みます。
33        // fgets はファイルの終端に達するか、読み込みエラーが発生すると false を返します。
34        // そのため、!== false で厳密にチェックします。
35        while (($line = $file->fgets()) !== false) {
36            echo "行 {$lineNumber} (改行コード含む): [" . $line . "]\n";
37            echo "行 {$lineNumber} (改行コード除去): [" . trim($line) . "]\n";
38            $lineNumber++;
39        }
40    } catch (RuntimeException $e) {
41        // ファイルが開けないなどの実行時エラーを捕捉します。
42        echo "エラーが発生しました: " . $e->getMessage() . "\n";
43    } finally {
44        // 4. 処理が完了したら、作成した一時ファイルを削除します。
45        // SplFileObject はオブジェクトがスコープ外れる際に自動的に閉じられますが、
46        // 一時ファイルは明示的に削除する必要があります。
47        if (file_exists($tempFileName)) {
48            unlink($tempFileName);
49            echo "\n--- テストファイル '{$tempFileName}' を削除しました ---\n";
50        }
51    }
52
53    echo "--- ファイル内容の読み込み終了 ---\n";
54}
55
56// 関数を実行して動作を確認します。
57demonstrateFgetsWithNewlineHandling();

SplFileObject::fgetsは、PHP 8で利用できるSplFileObjectクラスに属するメソッドで、開いているファイルから1行ずつデータを読み込む際に使用されます。

このメソッドは引数を取りません。ファイルから読み込んだ1行の文字列を返しますが、行の終端にある改行コード（例えば\nや\r\n）も文字列に含まれた状態で返される点が特徴です。ファイルの終端に達した場合や、何らかの読み込みエラーが発生した場合にはfalseが返されるため、これを読み込みループの終了条件として利用することができます。

サンプルコードでは、まず一時ファイルに複数行のテキストを書き込み、様々な形式の改行コードを含めています。その後、SplFileObjectでそのファイルを読み取りモードで開き、fgetsメソッドをwhileループの中で繰り返し呼び出すことで、ファイルの全内容を1行ずつ取得しています。読み込んだ各行は、改行コードを含んだままの場合と、trim()関数を使って改行コードを除去した場合の両方で出力されており、fgetsの具体的な挙動が分かりやすく示されています。処理の最後には、作成した一時ファイルが確実に削除され、システムへの影響を最小限に抑えています。