Phar::decompress

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

Phar::decompress — Decompresses the entire Phar archive

说明

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

Note:
此方法需要将 php.ini 中的 phar.readonly 设为 0 以适合 Phar 对象. 否则, 将抛出PharException.

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, .phar by default for phar archives, or .phar.tar for tar-based phar archives. Alternatively, a file extension may be specified with the second parameter.

参数

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.

返回值

A Phar object is returned.

错误／异常

Throws BadMethodCallException if the phar.readonly INI variable is on, the zlib extension is not available, or the bzip2 extension is not enabled.

范例

Example #1 A Phar::decompress() example


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

参见

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)
Phar::compress() - Compresses the entire Phar archive using Gzip or Bzip2 compression
Phar::getSupportedCompression() - Return array of supported compression algorithms
Phar::compressFiles() - Compresses all files in the current Phar archive
Phar::decompressFiles() - Decompresses all files in the current Phar archive

User Contributed Notes

shevadas at gmail dot com 26-Apr-2016 04:19


decompress() will truncate any part of the filename after the first period, as it assumes it's part of the extension. For example, if your PharData archive is named "views-3.x-3.13.tar.gz", calling decompress on it will create a tar file named "views-3.tar". See https://bugs.php.net/bug.php?id=58852