PharData::decompress
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
PharData::decompress — Decompresses the entire Phar archive
Description
PharData::decompress
([ string $extension
] ) : object
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.
Parameters
-
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.
Return Values
A PharData object is returned.
Examples
Example #1 A PharData::decompress() example
<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // creates /path/to/my.tar
?>