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

Copy
1<?php
2
3// このスクリプトは、gzeof() 関数を使用してGZ圧縮ファイルの終端を検出する方法を示します。
4// 実行すると、一時的なGZファイルを作成し、その内容を読み込み、最後にファイルを削除します。
5
6// 1. テスト用のGZファイルを作成する準備
7$file_name = 'example.gz';
8$original_content = "これはPHPのgzeof関数のテストです。\n";
9$original_content .= "複数行のテキストデータを含んでいます。\n";
10$original_content .= "ファイルの終端まで読み込まれることを確認します。\n";
11$original_content .= "これで最後の一行です。";
12
13// 2. gzopen() を使用して新しいGZファイルを作成し、内容を書き込む
14// 'wb9' モードは、書き込み用 ('w') でバイナリモード ('b')、最高の圧縮レベル ('9') を意味します。
15$gz_write_handle = gzopen($file_name, 'wb9');
16if ($gz_write_handle === false) {
17    die("エラー: テスト用GZファイル '{$file_name}' の作成に失敗しました。\n");
18}
19gzwrite($gz_write_handle, $original_content);
20gzclose($gz_write_handle);
21echo "テスト用GZファイル '{$file_name}' を作成しました。\n\n";
22
23// 3. gzopen() を使用して作成したGZファイルを読み込みモードで開く
24// 'rb' モードは、読み込み用 ('r') でバイナリモード ('b') を意味します。
25$gz_read_handle = gzopen($file_name, 'rb');
26
27// ファイルが開けなかった場合のエラーハンドリング
28if ($gz_read_handle === false) {
29    die("エラー: GZファイル '{$file_name}' を開けませんでした。\n");
30}
31
32echo "--- GZファイルの内容を読み込み中 ---\n";
33$line_number = 1;
34
35// 4. gzeof() を使用してファイルの終端に達するまでループで読み込む
36// gzeof() はファイルポインタがファイルの終端を超えた場合に true を返します。
37// そのため、'!gzeof()' は「ファイルの終端に達していない間は」という意味になります。
38while (!gzeof($gz_read_handle)) {
39    // gzgets() でGZファイルから1行読み込む
40    // 第二引数で最大読み込みバイト数を指定できますが、省略するとデフォルトの1024バイトになります。
41    $line_content = gzgets($gz_read_handle);
42
43    // gzgets() が false を返す場合は、読み込みエラーまたはEOFの直前を示す可能性があります。
44    if ($line_content === false) {
45        break; // ループを終了
46    }
47
48    // 読み込んだ行を表示 (末尾の改行コードは rtrim で削除)
49    echo "Line {$line_number}: " . rtrim($line_content) . "\n";
50    $line_number++;
51}
52echo "--- ファイルの読み込みが完了しました ---\n\n";
53
54// 5. gzclose() を使用して開いたファイルを閉じる
55gzclose($gz_read_handle);
56
57// 6. テスト用ファイルをクリーンアップ（削除）
58if (file_exists($file_name)) {
59    unlink($file_name);
60    echo "テスト用ファイル '{$file_name}' を削除しました。\n";
61}
62
63?>

PHPのgzeof関数は、GZ圧縮ファイルが終端に達したかどうかを検出するために使用されます。この関数は、gzopen関数などで開かれたGZファイルのリソースを引数（GzFile $stream）として受け取り、ファイルポインタがファイルの終端を超えた場合にtrueを、まだ終端に達していなければfalseをブール値で返します。

サンプルコードでは、まずgzopen関数を使ってテスト用のGZファイルを作成し、gzwriteで内容を書き込んでいます。その後、作成したGZファイルを読み込みモードで再びgzopenで開きます。gzeof関数は、while (!gzeof($gz_read_handle))という形でループの条件として利用され、GZファイルの終端に達するまでgzgets関数で1行ずつ内容を読み込み、表示しています。gzeofがtrueを返すと、ファイルの読み込みが完了したと判断され、ループが終了します。最終的に、gzclose関数で開いたファイルを閉じ、作成したテストファイルを削除してクリーンアップを行っています。このようにgzeofは、GZ圧縮されたファイルを最後まで安全かつ効率的に読み込むために不可欠な関数です。

Copy
1<?php
2
3/**
4 * gzeof関数を使用してgzip圧縮ファイルを読み込むサンプルです。
5 *
6 * この関数は、一時的なgzipファイルを作成し、その内容を読み込んで表示します。
7 * gzeof() は、gzファイルポインタが終端に達したかどうかをチェックするために使用されます。
8 */
9function readGzipFileContentExample(): void
10{
11    $filename = 'sample_gzeof.txt.gz';
12    $originalContent = "これはgzip圧縮されたファイルの内容です。\n"
13                     . "PHPのgzeof関数を使って、ファイル終端まで読み込みます。\n"
14                     . "複数の行にわたるテキストをテストします。";
15
16    // 1. サンプルgzipファイルを作成
17    echo "1. サンプルgzipファイル '{$filename}' を作成中...\n";
18    // 'wb'モードでgzipファイルを開き、バイナリ書き込みを行います
19    $gzFileWrite = gzopen($filename, 'wb');
20    if ($gzFileWrite === false) {
21        echo "エラー: gzipファイルの作成に失敗しました。\n";
22        return;
23    }
24    gzwrite($gzFileWrite, $originalContent); // 内容を書き込み
25    gzclose($gzFileWrite); // ファイルを閉じる
26    echo "   ファイル作成完了。\n";
27
28    // 2. 作成したgzipファイルを読み込みモードで開く
29    echo "2. '{$filename}' を読み込みモードで開きます。\n";
30    // 'rb'モードでgzipファイルを開き、バイナリ読み込みを行います
31    $gzFileRead = gzopen($filename, 'rb');
32    if ($gzFileRead === false) {
33        echo "エラー: gzipファイルのオープンに失敗しました。\n";
34        // 作成したファイルが存在する場合は削除
35        if (file_exists($filename)) {
36            unlink($filename);
37        }
38        return;
39    }
40
41    echo "3. ファイルの内容を読み込み中 (gzeof() を使用)...\n";
42    $readContent = '';
43    // gzeof($stream) は、ファイルポインタが圧縮ファイルの終端に達している場合に true を返します。
44    // ファイル終端に達していない間（!gzeof() が true の間）ループを続けます。
45    while (!gzeof($gzFileRead)) {
46        // gzread($stream, length) は、指定されたバイト数までデータを読み込みます。
47        // ここでは、一度に1024バイトずつ読み込んでいます。
48        $readContent .= gzread($gzFileRead, 1024);
49    }
50    
51    echo "--- 読み込んだ内容 ---\n";
52    echo $readContent;
53    echo "--- 読み込み終了 ---\n";
54
55    // 4. gzファイルを閉じる
56    gzclose($gzFileRead);
57    echo "4. '{$filename}' を閉じました。\n";
58
59    // 5. 後処理: サンプルファイルを削除
60    if (file_exists($filename)) {
61        unlink($filename);
62        echo "5. サンプルファイル '{$filename}' を削除しました。\n";
63    }
64}
65
66// サンプル関数を実行
67readGzipFileContentExample();

PHPのgzeof関数は、gzip形式で圧縮されたファイルを読み込む際に、ファイルポインタがそのファイルの終端（EOF: End Of File）に到達したかどうかを検査するために利用されます。この関数は、GzFile型のファイルポインタを引数として受け取ります。そして、ファイルポインタが終端に達している場合にはtrueを、まだ読み込み可能なデータが残っている場合にはfalseを、それぞれブール値で返します。

システムエンジニアを目指す初心者の方にとって、gzeofは圧縮ファイルのデータを安全に、そして完全に読み込むための重要なツールです。提供されたサンプルコードでは、まずgzopen関数を使ってgzipファイルを書き込みモードで作成し、任意のテキストを書き込みます。その後、同じファイルを読み込みモードで開き直し、while (!gzeof($gzFileRead))という条件を持つループ内でgzread関数を使用してデータを読み進めます。このループは、gzeofがtrueを返すまで、つまりファイル終端に到達するまで繰り返されるため、ファイル全体の内容を確実に取得することができます。読み込みが完了した後は、必ずgzclose関数でファイルポインタを閉じるようにしてください。gzeofは、このような圧縮ファイル読み込み処理において、ループ制御の要となる関数です。