(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
PharData::decompress — Decompresses the entire Phar archive
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.
extension
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.
Throws BadMethodCallException if the zlib extension is not available, or the bzip2 extension is not enabled.
| Version | Description |
|---|---|
| 8.0.0 |
extension is now nullable.
|
Example #1 A PharData::decompress() example
<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // creates /path/to/my.tar
?>