PharData::decompress

Decompresses the entire Phar archive

&reftitle.description; public ``PharData``null```PharData::decompress` ``string``null```extension`&null;

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.

&reftitle.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.

&reftitle.returnvalues;

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

&reftitle.errors;

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

&reftitle.changelog;

&Version; | &Description;
8.0.0 | `extension` is now nullable.

&reftitle.examples;

### A `PharData::decompress` example

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

&reftitle.seealso;

- `PharFileInfo::getCompressedSize`
- `PharFileInfo::isCompressed`
- `PharFileInfo::compress`
- `PharFileInfo::decompress`
- `PharData::compress`
- `Phar::canCompress`
- `Phar::isCompressed`
- `PharData::compress`
- `Phar::getSupportedCompression`
- `PharData::compressFiles`
- `PharData::decompressFiles`