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

eofメソッドは、SplTempFileObjectクラスに属し、ファイルポインタがファイルの終端（EOF: End Of File）に達したかどうかを確認するメソッドです。SplTempFileObjectは、PHPにおいて一時ファイルをメモリ上またはディスク上でオブジェクトとして扱うための組み込みクラスです。このeofメソッドは、主にファイルからデータを読み込む際のループ処理の終了条件として利用されます。

ファイルポインタがファイルの終端に到達した場合、このメソッドは真偽値のtrueを返します。まだファイルの内容が残っており、ファイルポインタがファイルの終端に達していない場合はfalseを返します。例えば、fgets()やfread()などのファイル読み込み関数を繰り返し実行し、読み取るべきデータがすべてなくなったときに、eof()はtrueを返すようになります。

この機能は、ファイルの内容を最初から最後まで順に処理する際に非常に重要です。典型的な使用例としては、「while (! $tempFileObject->eof()) { ...ファイルから一行読み込む処理... }」のように、ファイルポインタが終端に達するまで処理を続けるループを構築する場面が挙げられます。ファイルポインタをファイルの先頭に戻すrewind()メソッドなどを呼び出すと、eof()の状態はリセットされ、再度falseを返すようになります。ファイル処理の安全性と効率性を確保するために、ファイル読み込みの際にはこのeofメソッドを適切に利用することが推奨されます。

Copy
1<?php
2$tempFile = new SplTempFileObject();
3$tempFile->fwrite("First line.\n");
4$tempFile->fwrite("Second line.\n");
5$tempFile->rewind(); // ファイルポインタを先頭に戻す
6
7// ファイルの終端に達するまでコンテンツを読み進める
8while (!$tempFile->eof()) {
9    $tempFile->fgets(); // 読み込みによりファイルポインタを進める
10}
11// この時点で $tempFile->eof() は true を返す
12?>

引数なし

引数はありません

bool

eof メソッドは、ファイルポインタがファイルの終端に到達したかどうかを示す論理値（bool）を返します。ファイルの終端に達していれば true を、まだ達していない場合は false を返します。