PharData::decompress

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

PharData::decompress — Decompresses the entire Phar archive

说明

public PharData::decompress ( string|null $extension = null ) : Phar|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.

参数

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.

返回值

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

错误／异常

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

更新日志

版本	说明
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
?>

参见

PharFileInfo::getCompressedSize() - Returns the actual size of the file (with compression) inside the Phar archive
PharFileInfo::isCompressed() - Returns whether the entry is compressed
PharFileInfo::compress() - Compresses the current Phar entry with either zlib or bzip2 compression
PharFileInfo::decompress() - Decompresses the current Phar entry within the phar
PharData::compress() - Compresses the entire tar/zip archive using Gzip or Bzip2 compression
Phar::canCompress() - Returns whether phar extension supports compression using either zlib or bzip2
Phar::isCompressed() - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)
PharData::compress() - Compresses the entire tar/zip archive using Gzip or Bzip2 compression
Phar::getSupportedCompression() - Return array of supported compression algorithms
PharData::compressFiles() - Compresses all files in the current tar/zip archive
PharData::decompressFiles() - Decompresses all files in the current zip archive

User Contributed Notes

pttlens at gmail dot com 15-Nov-2018 08:25


If filename contains multiple dots(.), you can preserve other parts by following code (example1).



Example #1 (Expected)

<?php

$filename = "abc.xyz.tar.gz";

$p = new PharData($filename);

$exts = explode('.', $filename);

array_shift($exts);

array_pop($exts);

$ext = implode('.', $exts);

$p->decompress($ext); # result filename: abc.xyz.tar

?>



Example #2 (might be unexpected)

<?php

$filename = "abc.xyz.tar.gz";

$p = new PharData($filename);

$p->decompress($filename); # result filename: abc.tar; xyz is truncated accidentally.

?>