gzopen

関数の概要

gzopenは、PHPでgzip形式の圧縮ファイル（拡張子が通常は .gz のファイル）を読み書きするために使用される関数です。この関数を使うことで、圧縮されたファイルを直接開いて、読み込みや書き込み処理を行うことができます。特に大きなテキストデータやログファイルを圧縮形式で管理したい場合に便利です。

パラメータの説明

  • filename（string）: 開きたいgzipファイルのパスを指定します。
  • mode（string）: ファイルを開くモードを指定します。例えば、”rb”は読み込み専用のバイナリモード、”wb”は書き込み専用のバイナリモードです。
  • use_include_path（bool、省略可）: include_pathを利用するかどうかのフラグです。デフォルトはfalseです。
  • context（resource、PHP 5.3.0以降）: ストリームコンテキストを指定できます。通常は省略可能です。

戻り値

成功した場合、gzipファイルを操作するためのリソースハンドルを返します。失敗した場合は false を返します。

使用例

基本的な使い方：gzipファイルを読み込み

<?php
$gz = gzopen('sample.gz', 'rb');
if ($gz) {
    while (!gzeof($gz)) {
        echo gzread($gz, 4096);
    }
    gzclose($gz);
} else {
    echo "ファイルを開けませんでした。";
}
?>

この例では、gzipファイルを読み込み専用のモードで開き、中身を4096バイトずつ読み出して出力しています。最後に必ずファイルを閉じています。

gzipファイルにデータを書き込む

<?php
$data = "圧縮されたデータを書き込みます。n";

$gz = gzopen('output.gz', 'wb');
if ($gz) {
    gzwrite($gz, $data);
    gzclose($gz);
    echo "書き込みが完了しました。";
} else {
    echo "ファイルを開けませんでした。";
}
?>

この例では、gzip形式のファイルを作成し、テキストデータを書き込んでいます。モードは書き込み専用の wb を使います。

既存のgzipファイルに追記する

<?php
$gz = gzopen('log.gz', 'ab');
if ($gz) {
    gzwrite($gz, "追記するログ情報n");
    gzclose($gz);
    echo "追記が完了しました。";
} else {
    echo "ファイルを開けませんでした。";
}
?>

abモードを使うことで既存のgzipファイルに追記が可能です。ログファイルの管理などに活用できます。

関連する関数

  • gzread: gzipファイルからデータを読み込む
  • gzwrite: gzipファイルへデータを書き込む
  • gzeof: gzipファイルの終端かどうかを判定する
  • gzclose: gzipファイルを閉じる
  • gzcompress, gzuncompress: メモリ上で文字列の圧縮・解凍を行う

まとめ

gzopenを使うことで、PHPからgzip圧縮されたファイルを簡単に扱うことができます。読み込み・書き込み・追記など、さまざまなモードに対応しており、大量のテキストデータやログを圧縮形式で効率よく管理できます。圧縮ファイルの操作をしたい場合はまず gzopen を覚えておくと良いでしょう。

スポンサーリンク