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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * gzencode と gzopen を使用した GZIP 圧縮ファイルの読み書きサンプル。
7 *
8 * この関数は、指定された文字列データを GZIP 圧縮して一時ファイルに保存し、
9 * その後ファイルを読み込んで解凍し、元のデータを返します。
10 * システムエンジニアを目指す初心者向けに、各ステップの詳細とエラーハンドリングを含みます。
11 *
12 * @param string $originalData 圧縮・保存する元の文字列データ。
13 * @return string|false 正常に解凍されたデータ、または処理失敗時は false。
14 */
15function handleGzipFileOperation(string $originalData): string|false
16{
17    // 一時ファイルパスを生成
18    // sys_get_temp_dir() はシステムの一時ディレクトリのパスを返します。
19    $tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'sample.gz';
20
21    echo "一時ファイルパス: " . $tempFilePath . PHP_EOL;
22    echo "元のデータ:\n" . $originalData . PHP_EOL . PHP_EOL;
23
24    // 1. gzencode を使用してデータを GZIP 圧縮する
25    // gzencode は文字列を直接圧縮し、GZIP形式のバイナリ文字列を返します。
26    // 第2引数は圧縮レベル (0-9, 9が最高圧縮)。
27    $compressedData = gzencode($originalData, 9);
28    if ($compressedData === false) {
29        echo "エラー: データの圧縮に失敗しました。" . PHP_EOL;
30        return false;
31    }
32    echo "データが GZIP 形式に圧縮されました。" . PHP_EOL;
33
34    // 2. gzopen で GZIP ファイルを書き込みモードで開く
35    // 'wb9' モード:
36    //   w: 書き込み専用でファイルを開く (ファイルが存在すれば作成、なければ新規作成)。
37    //   b: バイナリモード。
38    //   9: 圧縮レベル (ファイル書き込み時のデフォルト圧縮レベルを上書き)。
39    $fileHandle = gzopen($tempFilePath, 'wb9');
40    if ($fileHandle === false) {
41        echo "エラー: GZIP ファイル '{$tempFilePath}' を開くことができませんでした。" . PHP_EOL;
42        return false;
43    }
44
45    // 圧縮されたデータをファイルに書き込む
46    // gzwrite は GZIP ファイルハンドルにデータを書き込みます。
47    // ここに渡すデータは、既にgzencodeで圧縮されたバイナリ文字列です。
48    if (gzwrite($fileHandle, $compressedData) === false) {
49        echo "エラー: データのファイルへの書き込みに失敗しました。" . PHP_EOL;
50        gzclose($fileHandle);
51        @unlink($tempFilePath); // 作成されたファイルを削除 (エラー抑制@付き)
52        return false;
53    }
54    gzclose($fileHandle); // ファイルハンドルを閉じる
55    echo "圧縮データがファイルに書き込まれました。" . PHP_EOL . PHP_EOL;
56
57    // 3. gzopen で GZIP ファイルを読み込みモードで開く
58    // 'rb' モード:
59    //   r: 読み込み専用でファイルを開く。
60    //   b: バイナリモード。
61    // gzopen で開いた GZIP ファイルは、読み込み時に自動的に解凍されます。
62    $fileHandle = gzopen($tempFilePath, 'rb');
63    if ($fileHandle === false) {
64        echo "エラー: GZIP ファイル '{$tempFilePath}' を読み込みモードで開くことができませんでした。" . PHP_EOL;
65        @unlink($tempFilePath); // ファイルを削除 (エラー抑制@付き)
66        return false;
67    }
68
69    // ファイルから全てのデータを読み込む (自動的に解凍される)
70    // gzread は指定されたバイト数だけ解凍されたデータを読み込みます。
71    // gzeof はファイルポインタが終端に達したかどうかをチェックします。
72    $decompressedDataFromFile = '';
73    while (!gzeof($fileHandle)) {
74        $decompressedDataFromFile .= gzread($fileHandle, 4096); // 4KBずつ読み込む
75    }
76    gzclose($fileHandle); // ファイルハンドルを閉じる
77    echo "ファイルからデータが読み込まれ、自動的に解凍されました。" . PHP_EOL;
78
79    // 一時ファイルを削除
80    @unlink($tempFilePath); // 確実に削除するため (エラー抑制@付き)
81    echo "一時ファイル '{$tempFilePath}' が削除されました。" . PHP_EOL . PHP_EOL;
82
83    return $decompressedDataFromFile;
84}
85
86// --- サンプルコードの実行部分 ---
87
88// 圧縮するサンプルデータを準備
89$dataToCompress = "これはGZIP圧縮を試すためのサンプルデータです。\n";
90$dataToCompress .= "PHPのgzencodeとgzopen関数を使って、このデータを圧縮してファイルに書き込み、\n";
91$dataToCompress .= "その後読み込んで解凍します。\n";
92$dataToCompress .= "システムエンジニアを目指す初心者の方にも分かりやすいように、\n";
93$dataToCompress .= "詳細なコメントとエラーハンドリングを含めています。\n";
94$dataToCompress .= "このコードは、ファイルがGZIP形式でどのように扱われるかを示しています。";
95
96// GZIP ファイル操作関数を実行
97$result = handleGzipFileOperation($dataToCompress);
98
99// 結果の表示と検証
100if ($result !== false) {
101    echo "----------------------------------------------------" . PHP_EOL;
102    echo "解凍されたデータ:\n" . $result . PHP_EOL;
103    echo "----------------------------------------------------" . PHP_EOL;
104
105    // 元のデータと解凍されたデータを比較して検証
106    if ($result === $dataToCompress) {
107        echo "検証結果: 元のデータと解凍されたデータは一致します。成功！" . PHP_EOL;
108    } else {
109        echo "検証結果: 元のデータと解凍されたデータが一致しません。エラー！" . PHP_EOL;
110    }
111} else {
112    echo "処理中にエラーが発生しました。" . PHP_EOL;
113}

PHPのgzopen関数は、GZIP形式で圧縮されたファイルを読み書きするための特別なファイルハンドルを開きます。この関数は、通常のファイル操作のように見えますが、内部でGZIPの圧縮・解凍を自動的に処理してくれる点が特徴です。

サンプルコードでは、まずgzencode関数を使って、指定された文字列データ自体をGZIP形式のバイナリデータに圧縮しています。次に、gzopenの第1引数にGZIPファイルのパス、第2引数$modeに'wb9'（書き込み用バイナリモードで最高圧縮レベル）を指定してファイルハンドルを取得し、gzwriteで圧縮データをファイルに書き込みます。gzopenは成功時にファイル操作用のresourceを、失敗時にはfalseを返すため、必ず戻り値を確認しエラー処理を行うことが重要です。

データ書き込み後、今度はgzopenを'rb'（読み込み用バイナリモード）で開き直します。このモードで開かれたファイルからgzreadでデータを読み込むと、ファイルに保存されたGZIP圧縮データが自動的に解凍されて取得されます。処理後はgzcloseでファイルハンドルを閉じ、一時ファイルを削除しています。この一連の操作により、GZIP圧縮ファイルの作成から読み込み・解凍までの基本的な流れと、gzencodeとの連携、そして適切なエラーハンドリングの方法を学べます。

Copy
1<?php
2
3/**
4 * gzopen関数を使用してgzip圧縮ファイルの読み書きを行うサンプルコードです。
5 * この関数は、指定されたファイル名でテキストデータをgzip形式で保存し、
6 * その後、同じファイルを読み込んで元のデータを復元します。
7 * gzopenは、ファイルストリームを扱う際にデータの自動的な圧縮・伸長を
8 * 提供するため、ファイルI/Oにおける「圧縮」の概念を理解するのに役立ちます。
9 *
10 * @param string $baseFilename 一時ファイルとして使用するベースのファイル名（拡張子なし）
11 * @return void
12 */
13function handleGzipFile(string $baseFilename): void
14{
15    echo "--- gzopen 関数を使った gzip ファイルの読み書き ---" . PHP_EOL;
16
17    // 元のテキストデータ。このデータがgzip形式で圧縮・保存されます。
18    $originalData = "これはテスト用のテキストデータです。PHPのgzopen関数を使ってgzip形式で圧縮・保存し、再度読み込みます。このデータはファイルに書き込まれる際に自動的に圧縮されます。";
19    // gzip圧縮ファイルのフルパスを構築します。拡張子として.gzを追加します。
20    $gzFilename = $baseFilename . ".gz";
21
22    echo "元のデータ: " . $originalData . PHP_EOL;
23    echo "処理対象の圧縮ファイル名: " . $gzFilename . PHP_EOL;
24
25    // --- 1. gzipファイルへの書き込み処理 ---
26    echo PHP_EOL . "--- ファイル書き込み処理開始 ---" . PHP_EOL;
27
28    // gzopenを使ってgzipファイルを書き込みモードで開きます。
29    // 'wb' はバイナリ書き込みモードを意味し、新しいファイルを作成するか、既存のファイルを上書きします。
30    // gzopenは成功するとファイルポインタ（リソース）を返し、失敗すると false を返します。
31    $gzHandle = gzopen($gzFilename, 'wb');
32    if ($gzHandle === false) {
33        echo "エラー: ファイル '" . $gzFilename . "' を書き込みモードで開けませんでした。" . PHP_EOL;
34        return; // エラーが発生したため、処理を終了します。
35    }
36    echo "'" . $gzFilename . "' を書き込みモードで開きました。" . PHP_EOL;
37
38    // gzwriteを使ってデータをgzipファイルに書き込みます。
39    // gzwriteは、書き込まれたデータを内部的にgzip圧縮してファイルに保存します。
40    $bytesWritten = gzwrite($gzHandle, $originalData);
41    if ($bytesWritten === false) {
42        echo "エラー: データ書き込み中に問題が発生しました。" . PHP_EOL;
43        gzclose($gzHandle); // エラーが発生した場合でも、開いたファイルは必ず閉じます。
44        return;
45    }
46    echo $bytesWritten . " バイトのデータをファイルに書き込みました (内部的に圧縮)。" . PHP_EOL;
47
48    // gzcloseでファイルを閉じます。
49    // これにより、ファイルへの全ての書き込みが完了し、ファイルリソースが解放されます。
50    gzclose($gzHandle);
51    echo "'" . $gzFilename . "' を閉じました。" . PHP_EOL;
52
53    // --- 2. gzipファイルからの読み込み処理 ---
54    echo PHP_EOL . "--- ファイル読み込み処理開始 ---" . PHP_EOL;
55
56    // gzopenを使ってgzipファイルを読み込みモードで開きます。
57    // 'rb' はバイナリ読み込みモードを意味します。
58    $gzHandle = gzopen($gzFilename, 'rb');
59    if ($gzHandle === false) {
60        echo "エラー: ファイル '" . $gzFilename . "' を読み込みモードで開けませんでした。" . PHP_EOL;
61        // 書き込みが成功していた可能性があるので、念のため作成したファイルを削除するクリーンアップを試みます。
62        if (file_exists($gzFilename)) {
63            unlink($gzFilename);
64            echo "クリーンアップ: '" . $gzFilename . "' を削除しました。" . PHP_EOL;
65        }
66        return;
67    }
68    echo "'" . $gzFilename . "' を読み込みモードで開きました。" . PHP_EOL;
69
70    // gzreadを使ってデータ全体をgzipファイルから読み込みます。
71    // gzreadは、読み込んだデータを自動的に伸長（解凍）して返します。
72    $readData = '';
73    // gzeof はファイルポインタが終端（End Of File）に達したかどうかをチェックします。
74    while (!gzeof($gzHandle)) {
75        $readData .= gzread($gzHandle, 4096); // 4KB (4096バイト) ずつデータを読み込みます。
76    }
77
78    // gzcloseでファイルを閉じます。
79    gzclose($gzHandle);
80    echo "'" . $gzFilename . "' を閉じました。" . PHP_EOL;
81
82    echo PHP_EOL . "読み込んだデータ: " . $readData . PHP_EOL;
83
84    // --- 3. 結果の確認とクリーンアップ ---
85    echo PHP_EOL . "--- 結果確認 ---" . PHP_EOL;
86    // 元のデータと読み込んだデータが一致するかを確認し、処理の成功を検証します。
87    if ($originalData === $readData) {
88        echo "✔ 成功: 元のデータと読み込んだデータは一致しました。gzipファイルの書き込み・読み込みが正しく行われました。" . PHP_EOL;
89    } else {
90        echo "✖ 失敗: 元のデータと読み込んだデータが一致しません。処理に問題が発生した可能性があります。" . PHP_EOL;
91    }
92
93    // 作成したgzipファイルを削除してクリーンアップします。
94    // `file_exists` でファイルが存在するか確認してから `unlink` で削除するのが安全です。
95    if (file_exists($gzFilename)) {
96        if (unlink($gzFilename)) {
97            echo "クリーンアップ: 作成したファイル '" . $gzFilename . "' を削除しました。" . PHP_EOL;
98        } else {
99            echo "警告: ファイル '" . $gzFilename . "' を削除できませんでした。手動での削除が必要かもしれません。" . PHP_EOL;
100        }
101    }
102    echo "--- 処理完了 ---" . PHP_EOL;
103}
104
105// このスクリプトが直接実行された場合にのみ handleGzipFile 関数を呼び出します。
106// これにより、他のスクリプトからこのファイルを `include` や `require` した場合に、
107// 意図せずサンプルコードが実行されるのを防ぎます。
108if (realpath($_SERVER['SCRIPT_FILENAME']) == realpath(__FILE__)) {
109    // システムの一時ディレクトリにファイルを生成することで、書き込み権限の問題を回避し、
110    // 環境に依存しない一時ファイルの使用を可能にします。
111    $tempFileName = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_gzopen_sample_data';
112    handleGzipFile($tempFileName);
113}
114

PHP 8のgzopen関数は、gzip形式で圧縮されたファイルを操作するための拡張機能です。この関数は、$filenameで指定されたファイルを$modeに応じたモード（例: 書き込み用の'wb'、読み込み用の'rb'）で開きます。$use_include_pathをtrueにすると、ファイルをPHPのinclude_pathからも探します。成功した場合はファイルポインタを表すresourceを、失敗した場合はfalseを返します。

サンプルコードでは、まずgzopenを書き込みモード（'wb'）で開いて元のテキストデータをファイルに保存しています。このとき、gzwrite関数が内部的にデータをgzip形式に圧縮し、ファイルに書き込みます。次に、同じgzipファイルを読み込みモード（'rb'）でgzopenし、gzeofとgzreadを使ってデータを読み出します。gzreadは読み込んだデータを自動的に伸長（解凍）するため、元のテキストデータが復元されます。このようにgzopenと関連関数を使用することで、開発者はファイルの圧縮・伸長処理を意識せず、通常のファイルと同様にデータを扱えるため、ディスク容量の節約やデータ転送の効率化に役立ちます。ファイルの操作後は、必ずgzclose関数でリソースを解放します。