【PHP8.x】feof()関数の使い方

Copy
1<?php
2
3/**
4 * feof() 関数の基本的な使用例。
5 * ファイルの終端 (End Of File) に達するまでファイルを1行ずつ読み込みます。
6 */
7
8// 1. テスト用のファイルを作成
9$filename = 'example.txt';
10$fileContent = "Hello PHP!\nThis is a sample line.\nfeof() checks for end of file.\n";
11
12// ファイルに内容を書き込む (ファイルがなければ新規作成、あれば上書き)
13file_put_contents($filename, $fileContent);
14
15echo "--- ファイル '{$filename}' の内容を読み込みます ---\n";
16
17// 2. ファイルを読み込みモード ('r') で開く
18// fopen() はファイルリソースを返し、エラー時は false を返します。
19$stream = fopen($filename, 'r');
20
21// ファイルが正常に開けたか確認
22if ($stream === false) {
23    echo "エラー: ファイル '{$filename}' を開けませんでした。\n";
24    exit(1); // スクリプトを終了
25}
26
27// 3. feof() を使用してファイルの終端まで読み込むループ
28// !feof($stream) は、ファイルポインタがファイルの終端にない間は true を返します。
29while (!feof($stream)) {
30    // fgets() でファイルから1行ずつ読み込む
31    // 行の終わりに改行文字も含まれる可能性があります。
32    $line = fgets($stream);
33
34    // fgets() が false を返す場合 (読み込むデータがない、またはエラー) を考慮
35    if ($line !== false) {
36        echo $line;
37    }
38}
39
40// 4. ファイルリソースを閉じる
41// fclose() で開いたファイルを必ず閉じ、リソースを解放します。
42fclose($stream);
43
44echo "--- ファイルの読み込みが完了しました ---\n";
45
46// 5. (オプション) 作成したテストファイルを削除
47// unlink($filename);
48
49?>

PHPのfeof関数は、ファイル操作中に現在のファイルポインタがファイルの終端（End Of File）に達したかどうかを確認するために使用される、基本的ながら重要な関数です。

この関数は、引数としてfopen()関数などで開かれたファイルのリソース（resource型）を一つ受け取ります。戻り値はブール値（bool型）で、ファイルの終端に達していればtrueを、まだ終端に達していなければfalseを返します。

提供されたサンプルコードでは、まずfopen()でexample.txtというファイルを読み込みモードで開き、そのリソースを$stream変数に格納しています。次に、while (!feof($stream))という条件式を用いたループが実行されます。この条件は「$streamがファイルの終端に達していない間はループを続ける」という意味になり、ファイル全体を読み込む際に利用されます。

ループ内ではfgets($stream)によってファイルから1行ずつデータが読み込まれ、画面に出力されます。fgets()が1行読み込むたびにファイルポインタは次の行へ移動し、最終的にファイルの終端に到達するとfeof($stream)がtrueを返すため、!feof($stream)がfalseとなりループが終了します。ファイル操作の完了後には、必ずfclose($stream)を呼び出してファイルリソースを閉じ、システムリソースを適切に解放することが推奨されます。

このように、feof関数はファイルを最後まで確実に読み込み処理を行う上で、安全かつ効率的な制御を実現する非常に役立つ関数です。

Copy
1<?php
2
3// ファイルの終端(EOF)に達したかどうかを確認する例
4$filename = 'example.txt';
5
6// ファイルが存在しない場合は作成する
7if (!file_exists($filename)) {
8    file_put_contents($filename, "This is a sample file.\nWith multiple lines.");
9}
10
11$file = fopen($filename, 'r');
12
13if ($file) {
14    while (!feof($file)) {
15        $line = fgets($file);
16        echo $line;
17    }
18
19    fclose($file);
20} else {
21    echo "ファイルのオープンに失敗しました。";
22}
23
24?>

PHPのfeof関数は、ファイルポインタがファイルの終端（EOF: End-of-File）に達したかどうかを確認するために使用されます。この関数は、ファイルストリーム $stream を引数として受け取ります。$streamは、fopen関数などで開かれたファイルリソースです。

feof関数は、ファイルポインタがファイルの終端に達している場合はtrue（真）を、そうでない場合はfalse（偽）を返します。この関数は、ファイルからデータを読み込むループ処理において、ループの終了条件を判定するために役立ちます。

サンプルコードでは、まずexample.txtというファイルを開き（存在しない場合は作成します）、fopen関数でファイルリソース $file を取得しています。次に、whileループを使ってファイルから1行ずつ読み込み、echoで出力しています。このwhileループの条件として !feof($file) が使われています。これは、「ファイルポインタがファイルの終端に達していない間」という条件を表します。つまり、feof($file)がtrueを返すまで、ループは継続されます。

fgets関数は、ファイルから1行読み込み、ファイルポインタを次の行に進めます。ファイルの終端に達すると、feof($file)はtrueを返し、ループが終了します。最後に、fclose($file)でファイルリソースを閉じます。もしファイルのオープンに失敗した場合は、エラーメッセージが表示されます。

Copy
1<?php
2
3// ファイルの終端 (EOF) に達したかどうかを確認するサンプルコード
4$filename = 'test.txt';
5
6// ファイルが存在しない場合は作成する
7if (!file_exists($filename)) {
8    file_put_contents($filename, "This is a test file.\n");
9}
10
11$file = fopen($filename, 'r');
12
13if ($file) {
14    // ファイルの終端に達するまで1行ずつ読み込む
15    while (!feof($file)) {
16        $line = fgets($file);
17        echo $line;
18    }
19
20    fclose($file);
21} else {
22    echo "ファイルを開けませんでした。\n";
23}
24
25?>

PHPのfeof関数は、ファイルポインタがファイルの終端(EOF)に達したかどうかを確認するために使用します。引数には、ファイルリソース $stream を指定します。このリソースは、fopen関数などでファイルを開いた際に得られるものです。feof関数は、ファイルポインタがファイルの終端に達していれば true を、そうでなければ false を返します。

上記のサンプルコードでは、まずtest.txtというファイルが存在するかどうかを確認し、存在しない場合は新規に作成します。次に、fopen関数でファイルを読み込みモード ('r') で開き、ファイルリソースを変数$fileに格納します。

whileループの中で、feof($file)を使ってファイルの終端に達したかどうかをチェックしています。!feof($file)は、「ファイル終端に達していない間」という意味になります。ループ内では、fgets($file)関数でファイルから1行ずつ読み込み、変数$lineに格納し、echoで画面に出力します。

このように、feof関数はwhileループなどの制御構造と組み合わせて、ファイル全体を読み込む処理を実装する際に非常に役立ちます。ファイル処理が終わったら、fclose($file)でファイルを閉じることを忘れないようにしてください。もしファイルを開けなかった場合は、エラーメッセージを表示します。feof関数を使用することで、ファイル読み込みが途中で止まることを防ぎ、確実にファイルの最後まで処理を行うことができます。

Copy
1<?php
2
3/**
4 * 指定されたファイルの内容を feof と while を使って読み込み、コンソールに出力する関数。
5 *
6 * @param string $filePath 読み込むファイルのパス。
7 * @return bool ファイルの読み込みが成功した場合は true、失敗した場合は false。
8 */
9function readFileWithFeof(string $filePath): bool
10{
11    // ファイルを読み込みモードで開きます。'r' は読み込み専用を意味します。
12    $fileHandle = fopen($filePath, 'r');
13
14    // ファイルが開けたか確認します。開けなかった場合はエラーメッセージを表示して終了します。
15    if ($fileHandle === false) {
16        echo "エラー: ファイル '{$filePath}' を開けませんでした。\n";
17        return false;
18    }
19
20    echo "--- ファイル内容の読み込み開始 ---\n";
21
22    // feof() はファイルポインタがファイルの終端にいるかをチェックします。
23    // !feof($fileHandle) は「ファイルの終端ではない間」という意味になります。
24    while (!feof($fileHandle)) {
25        // fgets() はファイルから1行を読み込みます。
26        // ファイルの終端に達した場合やエラーが発生した場合は false を返します。
27        $line = fgets($fileHandle);
28
29        // 読み込んだ行が false でない（つまり、正常に読み込めた）場合に表示します。
30        if ($line !== false) {
31            echo $line;
32        }
33    }
34
35    // ファイルの読み込みが終わったら、ファイルを閉じます。
36    // これにより、ファイルリソースが解放されます。
37    fclose($fileHandle);
38
39    echo "--- ファイル内容の読み込み終了 ---\n";
40
41    return true;
42}
43
44// --- 以下はサンプルコードを動作させるための準備と実行です ---
45
46// 1. テスト用のファイル名と内容を準備します。
47$testFileName = 'sample_file_for_feof.txt';
48$testContent = "これは feof 関数のサンプルファイルです。\n"
49             . "while ループを使ってファイルの終端まで読み込みます。\n"
50             . "システムエンジニアを目指す初心者の皆さん、頑張ってください！\n"
51             . "最終行です。";
52
53// 2. テスト用のファイルを作成し、内容を書き込みます。
54// file_put_contents() はファイルが存在しない場合は作成し、存在する場合は上書きします。
55if (file_put_contents($testFileName, $testContent) === false) {
56    echo "エラー: テストファイル '{$testFileName}' の作成に失敗しました。\n";
57    exit(1); // 処理を終了します。
58}
59
60echo "テストファイル '{$testFileName}' を作成しました。\n\n";
61
62// 3. 作成したテストファイルを readFileWithFeof 関数を使って読み込みます。
63if (!readFileWithFeof($testFileName)) {
64    echo "ファイル読み込み処理中にエラーが発生しました。\n";
65}
66
67echo "\n";
68
69// 4. テスト用に作成したファイルを削除します。
70// unlink() はファイルを削除する関数です。
71if (unlink($testFileName)) {
72    echo "テストファイル '{$testFileName}' を削除しました。\n";
73} else {
74    echo "エラー: テストファイル '{$testFileName}' の削除に失敗しました。\n";
75}
76

PHPのfeof関数は、指定されたファイルのリソースがファイルの終端に達しているかをチェックする関数です。引数にはresource型のファイルハンドルを渡し、ファイルの終端に達していればtrue、そうでなければfalseをbool型で返します。

このサンプルコードは、feofとwhileループを組み合わせて、指定されたテキストファイルを最初から最後まで1行ずつ読み込み、その内容をコンソールに出力する方法を示しています。

処理は、fopen関数でファイルを読み込みモードで開くことから始まります。ファイルが正常に開けたら、while (!feof($fileHandle))という条件でループを開始します。この条件は「ファイルポインタが終端に到達していない間」という意味で、feofがfalseを返す間はループが続きます。ループ内ではfgets関数を使ってファイルを1行ずつ読み込み、その内容を表示します。すべての行を読み終え、feofがtrueを返すとループが終了し、最後にfclose関数で開いたファイルリソースを解放します。

この一連の処理は、ファイルの内容を完全に読み込むための基本的なパターンであり、ファイル操作を学ぶ上で重要です。