PHP マニュアル: Phar アーカイブ全体の圧縮を解除する

public PharDatanull PharData::decompress(stringnull $extension = null)

tar 形式のアーカイブの場合は、このメソッドはアーカイブ全体の圧縮を解除します。

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

さらに、このメソッドは自動的にアーカイブの拡張子を変更し、 .tar をデフォルトで追加します。もうひとつの方法として、ファイルの拡張子を extension パラメータで指定することもできます。

extension: 圧縮を解除する場合、デフォルトのファイル拡張子は .tar です。このパラメータを使用すると、別の拡張子を指定することができます。実行可能なアーカイブのみが、ファイル名に .phar を含むことができることに注意しましょう。

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

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

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

例1 PharData::decompress の例

<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // これは、/path/to/my.tar を作成します
?>