【PHP8.x】gzeof関数の使い方

gzeof関数は、指定したgz-fileポインタがファイルの終端に達したかどうかを判定する関数です。この関数は、gzopen()関数によって返される、gzip圧縮ファイルへの有効なファイルポインタを引数として受け取ります。関数の主な目的は、ファイルからデータを読み取る際に、これ以上読み取るべきデータが残っているかを確認することです。ファイルポインタがファイルの末尾に到達している場合、この関数はtrueを返します。まだ読み取り可能なデータが残っている場合や、何らかのエラーが発生した場合にはfalseを返します。一般的に、gzgets()やgzread()のようなファイル読み込み関数と組み合わせて、whileループの条件として使用されます。例えば、while (!gzeof($handle)) のように記述することで、ファイルの終端に達するまで安全に内容を読み込み続ける処理を実装できます。この方法により、ファイルのサイズを事前に把握していなくても、すべてのデータを確実に処理することが可能になります。この関数はgzopen()で開いたファイルポインタ専用であり、fopen()で開いた通常のファイルポインタにはfeof()関数を使用する必要があります。

<?php

// テスト用のgzipファイルを作成します
$file_path = 'sample.txt.gz';
$gz_write = gzopen($file_path, 'w9');
gzwrite($gz_write, "First line.\n");
gzwrite($gz_write, "Second line.\n");
gzclose($gz_write);

// 読み込み用にgzipファイルを開きます
$gz_read = gzopen($file_path, 'r');

// gzeof() を使い、ファイルポインタが終端に達するまでループ処理をします
while (!gzeof($gz_read)) {
    // 1行ずつ読み込んで出力します
    echo gzgets($gz_read);
}

// ファイルを閉じます
gzclose($gz_read);

// テスト用のファイルを削除します
unlink($file_path);

?>

GzFile $stream

• GzFile $stream: 圧縮されたファイルストリームを表すGzFileオブジェクト

bool

指定されたファイルポインタが、ファイル終端に到達したかどうかを真偽値で返します。