PHP マニュアル: tar/zip アーカイブ全体を Gzip あるいは Bzip2 で圧縮する

説明

public PharDatanull PharData::compress(int $compression, stringnull $extension = null)

tar 形式のアーカイブの場合は、このメソッドはアーカイブ全体を gzip あるいは bzip2 で圧縮します。できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、 Phar 拡張モジュールで直接透過的に使用することもできます。

zip 形式のアーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮するためには zlib 拡張モジュールが、そして bzip2 で圧縮するためには bzip2 拡張モジュールが有効になっていなければなりません。

さらに、このメソッドは自動的にアーカイブの名前を変更し、 .gz あるいは .bz2 を追加します。Phar::NONE を渡して圧縮を解除した場合は拡張子も削除します。もうひとつの方法として、ファイルの拡張子を 2 番目のパラメータで指定することもできます。

パラメータ

compression: 圧縮を行う場合には Phar::GZ あるいは Phar::BZ2、圧縮を解除する場合には Phar::NONE を指定します。
extension: デフォルトでは、tar を圧縮する際の拡張子は .tar.gz あるいは .tar.bz2、伸長する際の拡張子は .tar となります。

戻り値

成功した場合は PharData オブジェクトを返します。失敗した場合は null を返します。

エラー / 例外

zlib 拡張モジュールが使用できない場合、あるいは bzip2 拡張モジュールが使用できない場合に BadMethodCallException をスローします。

変更履歴

バージョン	説明
8.0.0	`extension` は、nullable になりました。

例

例1 PharData::compress の例

<?php
$p = new PharData('/path/to/my.tar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p1 = $p->compress(Phar::GZ); // /path/to/my.tar.gz にコピーします
$p2 = $p->compress(Phar::BZ2); // /path/to/my.tar.bz2 にコピーします
$p3 = $p2->compress(Phar::NONE); // 例外: /path/to/my.tar が既に存在します
?>

参考

Phar::compress