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

Copy
1<?php
2
3/**
4 * SplTempFileObject::eof() メソッドの動作を示すサンプルコード。
5 * ファイルの終端 (End Of File) に達したかどうかを判定する方法を学びます。
6 */
7function demonstrateSplTempFileObjectEof(): void
8{
9    // SplTempFileObject を作成します。これは一時的なファイル（デフォルトではメモリ内）を扱います。
10    // メモリを使いすぎると自動的にディスクに書き込まれます。
11    $file = new SplTempFileObject();
12
13    // 一時ファイルにサンプルデータを書き込みます。
14    $file->fwrite("PHP is a popular general-purpose scripting language.\n");
15    $file->fwrite("It is especially suited to web development.\n");
16    $file->fwrite("Fast, flexible, and pragmatic, PHP powers everything from your blog to the most popular websites in the world.\n");
17
18    // ファイルポインタをファイルの先頭に戻します。
19    // 書き込み後に読み込みを開始するために必要です。
20    $file->rewind();
21
22    echo "--- ファイルの読み込み開始 ---\n";
23
24    // eof() メソッドを使ってファイルの終端に達するまでループで読み込みます。
25    // $file->eof() が false の間、つまりファイルの終端ではない間はループを続けます。
26    while (!$file->eof()) {
27        $line = $file->fgets(); // ファイルから1行読み込み、ファイルポインタを進めます。
28        echo "読み込んだ行: " . trim($line) . "\n";
29        // eof() の現在の値を出力し、ファイルポインタの位置に応じて値が変わることを確認します。
30        echo "  eof() の現在値: " . ($file->eof() ? 'true' : 'false') . "\n";
31    }
32
33    echo "--- ファイルの読み込み終了 ---\n";
34
35    // ループ終了後、ファイルポインタは終端に達しています。
36    // この時点で eof() を呼び出すと 'true' が返されるはずです。
37    echo "ファイル終端到達後、eof() の最終値: " . ($file->eof() ? 'true' : 'false') . "\n";
38}
39
40// 関数を実行して動作を確認します。
41demonstrateSplTempFileObjectEof();
42

PHP 8のSplTempFileObject::eof()メソッドは、一時ファイルを操作する際に、ファイルポインタがファイルの終端（End Of File）に達したかどうかを判定するために使用します。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。ファイル終端に達していればtrue、まだ達していなければfalseです。

サンプルコードでは、まずメモリ上の一時ファイルを扱うSplTempFileObjectを作成し、そこに複数の文字列を書き込んでいます。書き込み後、rewind()メソッドでファイルポインタをファイルの先頭に戻し、読み込みの準備をします。

その後、while (!$file->eof())という条件でループを構築しています。これは、「ファイルの終端ではない間（eof()がfalseの間）はループを続ける」という意味です。ループ内でfgets()メソッドを使ってファイルを1行ずつ読み込み、読み込みが完了するたびにファイルポインタが次に進みます。ファイルポインタが終端に達するとeof()はtrueを返すため、ループが終了します。この仕組みにより、ファイルの内容を最初から最後まで確実に読み込むことが可能になります。

Copy
1<?php
2
3/**
4 * SplTempFileObject::eof() メソッドの使用例。
5 * 一時ファイルに複数行のデータを書き込み、ファイルの終端 (EOF) に達するまで
6 * 一行ずつ読み込みます。改行コードを含む行の扱いに注目してください。
7 */
8function demonstrateSplTempFileObjectEof(): void
9{
10    // SplTempFileObject のインスタンスを作成します。
11    // 'php://memory' を使用すると、メモリ内に一時ファイルが作成され、
12    // ディスクに保存する手間なくファイル操作をテストできます。
13    $file = new SplTempFileObject('php://memory');
14
15    // ファイルに複数行のデータを書き込みます。
16    // 各行の終わりに改行コード (\n) を含めることが重要です。
17    $file->fwrite("PHPはWeb開発によく使われます。\n");
18    $file->fwrite("バージョン8では多くの新機能が追加されました。\n");
19    $file->fwrite("この行がファイルの最後のデータです。\n");
20
21    echo "--- ファイル内容の読み込み開始 ---\n";
22
23    // ファイルポインタをファイルの先頭に戻します。
24    // 書き込み後に読み込みを開始するためには、この操作が必要です。
25    $file->rewind();
26
27    // ファイルポインタがファイルの終端 (EOF) に達するまでループを続けます。
28    // eof() メソッドは、ファイルポインタが終端にある場合に true を返します。
29    // fgets() を呼び出した後にファイルポインタが次の行の先頭に移動します。
30    // 最後の行を読み込んだ後、さらに fgets() を呼び出そうとすると eof() が true になります。
31    while (!$file->eof()) {
32        $line = $file->fgets(); // ファイルから一行読み込みます。
33                                // fgets() は改行コード (\n) も含めて行を読み込みます。
34
35        // 読み込んだ行を表示します。見やすくするために改行コードを除去しても良いですが、
36        // ここではそのまま表示し、fgets() が改行コードを含むことを示します。
37        echo "読み込んだ行: " . rtrim($line) . " [現在のEOF状態: " . ($file->eof() ? "true" : "false") . "]\n";
38    }
39
40    echo "--- ファイル内容の読み込み終了 ---\n";
41
42    // ループ終了後、ファイルポインタが終端に達していることを確認します。
43    echo "読み込み終了後、EOFに達していますか？ " . ($file->eof() ? "はい" : "いいえ") . "\n";
44}
45
46// 関数を実行します。
47demonstrateSplTempFileObjectEof();
48
49?>

SplTempFileObject::eof()メソッドは、PHP 8のSplTempFileObjectクラスに属し、一時ファイルの内容を読み込む際に、ファイルの終端に達したかどうかを判定するために使用されます。このメソッドは引数を取らず、戻り値としてブール値（trueまたはfalse）を返します。ファイルの終端に到達していればtrue、まだ読み込むべきデータが残っていればfalseを返します。

サンプルコードでは、まずメモリ上に一時ファイルを作成し、複数行のデータを書き込んでいます。ここで各行は改行コード\nで区切られています。書き込み後、rewind()メソッドを呼び出してファイルポインタをファイルの先頭に戻し、読み込みを開始する準備を整えます。

その後、while (!$file->eof())という条件でループを回し、ファイルの終端に達するまでfgets()メソッドで一行ずつデータを読み込みます。fgets()は改行コードを含む一行を読み取り、ファイルポインタを次の行の先頭に移動させます。重要な点として、fgets()がファイルの最後の行を読み込んだ直後でも、eof()はまだfalseを返すことがあります。これは、ファイルポインタが最後のデータの直後にはいるものの、「ファイルの終端そのもの」にはまだ到達していないためです。さらに読み込みを試み、読み込むデータがもう存在しないと判断された時点で、eof()がtrueを返します。これによりループが終了し、ファイルの内容が最後まで正しく処理されたことを確認できます。