大网数据广告活动
PHP 语言与运行手册

Phar::decompress · Decompresses the entire Phar archive

· 52CE 我爱测

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

Phar::decompress

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

Phar::decompress — Decompresses the entire Phar archive

说明

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

注意:

此方法需要 将 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.

返回值

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

错误/异常

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
?>

参见

来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
PHP Documentation Group
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 3.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。