Phar::decompress

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

Phar::decompress — Decompresses the entire Phar archive

Description

public function Phar::decompress(?string $extension = null): ?Phar

Note:

This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

For tar-based and phar-based phar archives, this method decompresses the entire archive. The decompressed archive is written as a new file in the same directory as the original archive, and is returned as a new Phar object. The original archive is not modified.

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 new archive, .phar by default for phar archives, or .phar.tar for tar-based phar archives. For example, decompressing /path/to/my.phar.gz creates /path/to/my.phar. Alternatively, a file extension may be specified with the extension parameter.

Parameters

extension

For decompressing, the default file extensions are .phar and .phar.tar. Use this parameter to specify another file extension. Be aware that all executable phar archives must contain .phar in their filename.

The extension replaces the archive's own extension (such as .phar.gz or .tar.gz), so passing decompressed.phar when decompressing /path/to/my.phar.gz creates /path/to/my.decompressed.phar.

Return Values

A Phar object is returned on success, and null on failure.

Errors/Exceptions

Throws BadMethodCallException if the phar.readonly INI variable is on, the zlib extension is not available, the bzip2 extension is not enabled, or a phar with the new filename already exists.

Changelog

Version Description
8.0.0 extension is now nullable.

Examples

Example #1 A Phar::decompress() example

<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p2 = $p->compress(Phar::GZ); // creates /path/to/my.phar.gz
$p3 = $p2->decompress('decompressed.phar'); // creates /path/to/my.decompressed.phar
?>

See Also