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

Copy
1<?php
2
3/**
4 * gzfile 関数を使って圧縮ファイルの内容を読み込むサンプルコードです。
5 * gzfile は、gzip 圧縮されたファイルを読み込み、その内容を行ごとに配列として返します。
6 */
7function demonstrateGzfileUsage(): void
8{
9    // 1. テスト用の圧縮ファイルの内容を準備します
10    $originalContent = "これはテスト用の圧縮ファイルです。\n";
11    $originalContent .= "gzfile 関数は、このファイルを解凍して行ごとに読み込みます。\n";
12    $originalContent .= "各行は配列の要素として返されます。";
13
14    // 2. 一時的な gz 圧縮ファイルを作成します
15    // sys_get_temp_dir() でOSの一時ディレクトリを取得し、そこでファイルを操作します。
16    $gzFilename = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'sample.gz';
17
18    // gzopen で圧縮ファイルを開き、'wb' モード（バイナリ書き込み）で書き込みます
19    $gzFileHandle = gzopen($gzFilename, 'wb');
20    if ($gzFileHandle === false) {
21        echo "エラー: 一時的なgzファイル '{$gzFilename}' を作成できませんでした。\n";
22        return;
23    }
24
25    gzwrite($gzFileHandle, $originalContent); // 内容をファイルに書き込みます
26    gzclose($gzFileHandle); // ファイルを閉じます
27
28    echo "一時的な圧縮ファイル '{$gzFilename}' を作成しました。\n\n";
29
30    // 3. gzfile 関数を使って、作成した圧縮ファイルの内容を読み込みます
31    echo "gzfile() 関数で圧縮ファイルを読み込み中...\n";
32    $lines = gzfile($gzFilename);
33
34    // 4. 読み込み結果を評価し、表示します
35    if ($lines === false) {
36        echo "エラー: '{$gzFilename}' をgzfile()で読み込むことができませんでした。\n";
37    } else {
38        echo "--- ファイルの内容 (解凍後) ---\n";
39        foreach ($lines as $lineNumber => $line) {
40            // gzfile は行末の改行コードも含めて読み込むため、rtrim() で除去して表示します
41            echo "行 " . ($lineNumber + 1) . ": " . rtrim($line) . "\n";
42        }
43        echo "---------------------------\n";
44    }
45
46    // 5. 後処理として、作成した一時ファイルを削除します
47    if (file_exists($gzFilename)) {
48        unlink($gzFilename); // ファイルを削除します
49        echo "\n一時ファイル '{$gzFilename}' を削除しました。\n";
50    }
51}
52
53// 関数を実行します
54demonstrateGzfileUsage();
55
56?>

PHP 8のgzfile関数は、gzip形式で圧縮されたファイルを解凍し、その内容を行ごとに読み込んで配列として返す便利な機能です。通常のfile関数と同様に、ファイル全体を一度に読み込み、各行を配列の要素として扱える点が特徴です。

第一引数$filenameには、読み込みたいgzip圧縮ファイルのパスを文字列で指定します。オプションの第二引数$use_include_pathを1に設定すると、通常のファイルパスに加えてPHPのinclude_pathに設定されたディレクトリも検索対象に含めることができます。さらに、オプションの第三引数$contextを使用すると、ファイルアクセス時の振る舞いを制御するストリームコンテキストを指定することも可能です。

この関数は、読み込みが成功した場合、ファイルの内容を行ごとの文字列として含む配列を返します。ファイルが存在しない、または読み込み権限がないなどの理由で失敗した場合はfalseを返します。サンプルコードでは、テスト用の圧縮ファイルを一時的に作成し、そのファイルをgzfile関数で読み込む具体的な手順を示しています。読み込まれた各行には改行コードが含まれるため、表示時にはrtrim()関数を使って除去し、整形された出力を行っています。このようにgzfile関数を使うことで、開発者は圧縮ファイルの扱いを簡潔に記述できます。

Copy
1<?php
2
3// 一時的なgzipファイルを作成し、その内容をgzfile関数で読み込むサンプル
4
5// 一時的なgzipファイル名
6$gzFilename = 'sample_data.gz';
7
8// ファイルに書き込むサンプルデータ（複数行）
9$fileContent = "これは1行目のデータです。\n"
10             . "これは2行目のデータです。\n"
11             . "これは3行目のデータです。\n"
12             . "ファイルの終端です。\n";
13
14// gzfile関数が読み込むためのgzip圧縮ファイルを準備します。
15// gzopenで書き込みモードでファイルを開き、gzwriteで内容を書き込み、gzcloseで閉じます。
16if ($gz = gzopen($gzFilename, 'wb')) { // 'wb' はバイナリ書き込みモードで新規作成
17    gzwrite($gz, $fileContent);
18    gzclose($gz);
19    echo "情報: 圧縮ファイル '{$gzFilename}' を作成しました。\n\n";
20} else {
21    // ファイルの作成に失敗した場合
22    die("エラー: 圧縮ファイル '{$gzFilename}' の作成に失敗しました。\n");
23}
24
25// gzfile関数を使用してgzip圧縮ファイルを読み込みます。
26// 各行が配列の要素として返されます。読み込みに失敗した場合はfalseが返されます。
27$lines = gzfile($gzFilename);
28
29if ($lines === false) {
30    // ファイルの読み込みに失敗した場合
31    echo "エラー: 圧縮ファイル '{$gzFilename}' の読み込みに失敗しました。\n";
32} else {
33    // 正常に読み込めた場合、内容を表示します。
34    echo "ファイル '{$gzFilename}' の内容:\n";
35    foreach ($lines as $lineNumber => $line) {
36        // gzfileは行末の改行文字を含んだまま読み込むため、表示前にrtrimで削除すると見やすくなります。
37        echo "  " . ($lineNumber + 1) . ": " . rtrim($line) . "\n";
38    }
39}
40
41// サンプルコードの実行後、作成した一時ファイルを削除してクリーンアップします。
42if (file_exists($gzFilename)) {
43    unlink($gzFilename);
44    echo "\n情報: 圧縮ファイル '{$gzFilename}' を削除しました。\n";
45}
46
47?>

PHP 8のgzfile関数は、指定されたgzip圧縮ファイルを読み込むための関数です。この関数は、ファイルの内容を行ごとに配列として取得する際に使用します。

引数$filenameには、読み込み対象のgzip圧縮ファイルのパスを文字列で指定します。$use_include_pathと$contextは、より高度なファイルパス探索やストリーム操作のために用意されていますが、通常は省略可能です。

関数の戻り値は、処理の成否によって異なります。ファイルを正常に読み込めた場合は、ファイル内の各行が要素として格納されたarrayが返されます。このとき、配列の各要素には行末の改行文字を含んだ文字列が格納されますので、表示する際にはrtrimなどで整形すると良いでしょう。ファイルの読み込みに失敗した場合は、falseが返されます。このfalseをチェックすることで、エラーハンドリングを行うことができます。

サンプルコードでは、まずgzopenなどを使って一時的なgzip圧縮ファイルを作成しています。次に、作成したsample_data.gzファイルをgzfile関数で読み込み、その内容を画面に1行ずつ表示しています。最後に、作成した一時ファイルを削除し、後処理も行っています。