Phar::compress
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
Phar::compress — Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
説明
public Phar::compress
( int $compression
[, string $extension
] ) : Phar
注意:
このメソッドは、
php.iniのphar.readonlyが0でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。
tar 形式あるいは phar 形式の phar アーカイブの場合は、 このメソッドはアーカイブ全体を gzip あるいは bzip2 で圧縮します。 できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、 Phar 拡張モジュールで直接透過的に使用することもできます。
zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮するためには zlib 拡張モジュールが、そして bzip2 で圧縮するためには bzip2 拡張モジュールが有効になっていなければなりません。 この関数は phar の内容を変更するので、使用するには INI 設定 phar.readonly が off になっていなければなりません。
さらに、このメソッドは自動的にアーカイブの名前を変更し、
.gz あるいは .bz2
を追加します。Phar::NONE
を渡して圧縮を解除した場合は拡張子も削除します。
もうひとつの方法として、ファイルの拡張子を 2 番目のパラメータで指定することもできます。
パラメータ
compression- 圧縮を行う場合には
Phar::GZあるいはPhar::BZ2、圧縮を解除する場合にはPhar::NONEを指定します。 extension- デフォルトでは、phar 形式のアーカイブを圧縮する際の拡張子は
.phar.gzあるいは.phar.bz2となり、tar 形式のアーカイブを圧縮する際の拡張子は.phar.tar.gzあるいは.phar.tar.bz2となります。伸長の際は、デフォルトの拡張子は.pharおよび.phar.tarとなります。
エラー / 例外
INI 設定 phar.readonly が on の場合、zlib 拡張モジュールが使用できない場合、あるいは bzip2 拡張モジュールが使用できない場合に BadMethodCallException をスローします。
例
例1 Phar::compress() の例
<?php$p = new Phar('/path/to/my.phar', 0, 'my.phar');$p['myfile.txt'] = 'hi';$p['myfile2.txt'] = 'hi';$p1 = $p->compress(Phar::GZ); // /path/to/my.phar.gz にコピーします$p2 = $p->compress(Phar::BZ2); // /path/to/my.phar.bz2 にコピーします$p3 = $p2->compress(Phar::NONE); // 例外: /path/to/my.phar は既に存在します?>
参考
- PharFileInfo::getCompressedSize() - Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す
- PharFileInfo::isCompressed() - エントリが圧縮されているかどうかを調べる
- PharFileInfo::compress() - 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する
- PharFileInfo::decompress() - phar 内の現在の Phar エントリの圧縮を解除する
- PharData::compress() - tar/zip アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
- Phar::canCompress() - phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す
- Phar::isCompressed() - phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す
- Phar::decompress() - Phar アーカイブ全体の圧縮を解除する
- Phar::getSupportedCompression() - サポートする圧縮アルゴリズムの配列を返す
- Phar::compressFiles() - 現在の Phar アーカイブ内のすべてのファイルを圧縮する
- Phar::decompressFiles() - 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
