PHPCon Poland 2024


(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

PharData::decompressDecompresses the entire Phar archive


public PharData::decompress(?string $extension = null): ?PharData

For tar-based archives, this method decompresses the entire archive.

For Zip-based archives, this method fails with an exception. The zlib extension must be enabled to decompress an archive compressed with gzip compression, and the bzip2 extension must be enabled in order to decompress an archive compressed with bzip2 compression.

In addition, this method automatically renames the file extension of the archive, .tar by default. Alternatively, a file extension may be specified with the extension parameter.

Bağımsız Değişkenler


For decompressing, the default file extension is .tar. Use this parameter to specify another file extension. Be aware that only executable archives can contain .phar in their filename.

Dönen Değerler

A PharData object is returned on success, or null on failure.


Throws BadMethodCallException if the zlib extension is not available, or the bzip2 extension is not enabled.

Sürüm Bilgisi

Sürüm: Açıklama
8.0.0 extension is now nullable.


Örnek 1 A PharData::decompress() example

= new PharData('/path/to/my.tar.gz');
$p->decompress(); // creates /path/to/my.tar

Ayrıca Bakınız

add a note

User Contributed Notes 1 note

pttlens at gmail dot com
5 years ago
If filename contains multiple dots(.), you can preserve other parts by following code (example1).

Example #1 (Expected)
= "";
$p = new PharData($filename);
$exts = explode('.', $filename);
$ext = implode('.', $exts);
$p->decompress($ext); # result filename:

Example #2 (might be unexpected)
= "";
$p = new PharData($filename);
$p->decompress($filename); # result filename: abc.tar; xyz is truncated accidentally.
To Top