gzencode

(PHP 4 >= 4.0.4, PHP 5)

gzencode -- gzip 圧縮された文字列を作成

説明

string gzencode ( string data [, int level [, int encoding_mode]] )

この関数は、入力 datagzip プログラムの出力と互換性のある形式で圧縮 して返します。

GZIPファイルフォーマットに関する詳細な情報については、次のドキュ メントを参照ください。 GZIP file format specification version 4.3 (RFC 1952)

パラメータ

data

エンコードするデータを指定します

level

圧縮レベルを指定します。 圧縮をしない場合に 0、最大限の圧縮を行う場合に9を指定可能です。 指定されない場合のデフォルト圧縮レベルは、 zlib ライブラリのデフォルト圧縮レベルになります。

encoding_mode

エンコーディングモードを指定します。 FORCE_GZIP (デフォルト) もしくは FORCE_DEFLATE を指定可能です。

もし FORCE_DEFLATE を使用した場合、 crc32 チェックサムが付加されていない gzip ファイルヘッダに続いて標準的な zlib 収縮文字列 (zlib ヘッダを含む) を受け取るでしょう。

返り値

エンコードされた文字列、もしくはエラー発生時に FALSE

結果データは標準的な .gz ファイルを構成するための適当なヘッダとデータ構造を含みます。

例 1. gzip ファイルを生成する

<?php
$data
= implode("", file("bigfile.txt"));
$gzdata = gzencode($data, 9);
$fp = fopen("bigfile.txt.gz", "w");
fwrite($fp, $gzdata);
fclose($fp);
?>

変更履歴

バージョン説明
4.2 level が追加されました。 gzencode() は、data とその前の encoding_mode オプションパラメータだけがありました。

参考

gzdeflate()
gzinflate()
gzuncompress()
gzcompress()