Phar::decompress
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
Phar::decompress — Decompresses the entire Phar archive
说明
注意:
此方法需要 将 php.ini 中的
phar.readonly设为0以适合 Phar 对象. 否则, 将抛出PharException.
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.
参数
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.
错误/异常
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.
更新日志
| 版本 | 说明 |
|---|---|
| 8.0.0 |
extension is now nullable.
|
示例
示例 #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
?>参见
- 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
来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。
