|
Phar::decompressDecompresses the entire Phar archive Description
public Pharnull Phar::decompress(stringnull
$extension = null )
For tar-based and phar-based phar archives, this method decompresses the entire archive. For Zip-based phar 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. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed.
In addition, this method automatically changes the file extension of the archive,
Parameters
Return Values
A Phar object is returned on success, and Errors/ExceptionsThrows BadMethodCallException if the phar.readonly INI variable is on, the zlib extension is not available, or the bzip2 extension is not enabled. Changelog
Examples
Example #1 A Phar::decompress example
See Also
|