Phar::decompress
Phar アーカイブ全体の圧縮を解除する
説明
public Pharnull Phar::decompress(stringnull $extension = null)
注意:
このメソッドは、php.ini の phar.readonly
が 0 でないと Phar
オブジェクトで動作しません。それ以外の場合は
PharException がスローされます。
tar 形式あるいは phar 形式の phar アーカイブの場合は、
このメソッドはアーカイブ全体の圧縮を解除します。
圧縮を解除したアーカイブは、元のアーカイブと同じディレクトリに別のファイルとして書き込まれ、
新しい Phar オブジェクトとして返されます。
元のアーカイブは変更されません。
zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。
gzip で圧縮されたファイルの圧縮を解除するためには zlib
拡張モジュールが、そして bzip2 で圧縮されたファイルの圧縮を解除するためには
bzip2 拡張モジュールが有効になっていなければなりません。
この関数は phar の内容を変更するので、使用するには INI 設定
phar.readonly
が off になっていなければなりません。
さらに、このメソッドは新しいアーカイブの拡張子を自動的に変更します。
デフォルトの拡張子は、phar アーカイブなら .phar、
tar 形式のアーカイブなら .phar.tar です。
たとえば、/path/to/my.phar.gz の圧縮を解除すると
/path/to/my.phar が作成されます。
もうひとつの方法として、ファイルの拡張子を
extension 引数で指定することもできます。
パラメータ
-
extension
-
圧縮を解除する場合、デフォルトのファイル拡張子は
.phar および .phar.tar です。
このパラメータを使用すると、別の拡張子を指定することができます。
実行可能な phar アーカイブは、ファイル名に必ず
.phar を含まなければならないことに注意しましょう。
元のアーカイブの拡張子 (.phar.gz
や .tar.gz など) は、指定した拡張子に置き換わります。
そのため、decompressed.phar を渡して
/path/to/my.phar.gz の圧縮を解除すると、
/path/to/my.decompressed.phar が作成されます。
戻り値
Phar オブジェクトを返します。
失敗した場合は null を返します。
エラー / 例外
INI 設定 phar.readonly
が on の場合、zlib
拡張モジュールが使用できない場合、
bzip2 拡張モジュールが使用できない場合、
作成するアーカイブと同じ名前の phar が既に存在する場合に
BadMethodCallException をスローします。
例
例1 Phar::decompress の例
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p2 = $p->compress(Phar::GZ); // /path/to/my.phar.gz を作成します
$p3 = $p2->decompress('decompressed.phar'); // /path/to/my.decompressed.phar を作成します
?>
参考
- PharFileInfo::getCompressedSize
- PharFileInfo::isCompressed
- PharFileInfo::compress
- PharFileInfo::decompress
- PharData::compress
- Phar::canCompress
- Phar::isCompressed
- Phar::compress
- Phar::getSupportedCompression
- Phar::compressFiles
- Phar::decompressFiles