PHP8 Phar::compress
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
Phar::compress — 使用 Gzip 或 Bzip2 压缩整个 Phar 存档
说明
public Phar::compress(int $compression, ?string $extension = null): ?Phar
注意:此方法需要 将 中的 设为 以适合 Phar 对象. 否则, 将抛出PharException.php.iniphar.readonly0
对于基于 tar 和 phar 的 phar 存档,此方法使用 gzip 压缩或 bzip2 压缩。生成的文件可以用 gunzip 命令/bunzip 命令,或使用 Phar 直接透明地访问 外延。
对于基于 ZIP 的 phar 存档,此方法将失败并出现异常。 必须启用 zlib 扩展才能压缩 使用 gzip 压缩时,bzip2 扩展名必须 启用以使用 bzip2 压缩进行压缩。 与修改 phar 内容的所有功能一样,phar.readonly INI 变量必须关闭 为了成功。
此外,如果传递给扩展名,此方法会自动重命名存档、追加或删除扩展名 删除压缩。或者,可以将文件扩展名指定为第二个 参数。.gz.bz2Phar::NONE
参数
compression
压缩必须是 之一,以添加压缩或删除压缩。
Phar::GZ
Phar::BZ2
Phar::NONE
extension
默认情况下,扩展名是 or 用于压缩 phar 存档,而 or 用于 压缩 tar 存档。对于解压缩,默认文件扩展名 是 和 .
.phar.gz
.phar.bz2
.phar.tar.gz
.phar.tar.bz2
.phar
.phar.tar
返回值
返回 Phar 对象,或在失败时返回 null。
错误/异常
如果出现以下情况,则引发 BadMethodCallException phar.readonly INI 变量处于打开状态,zlib 扩展不可用,或者 bzip2 扩展 未启用。
更新日志
版本 | 说明 |
---|---|
8.0.0 | extension 现在是可为 null 的。 |
示例
示例 #1 A Phar::compress() example
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p1 = $p->compress(Phar::GZ); // copies to /path/to/my.phar.gz
$p2 = $p->compress(Phar::BZ2); // copies to /path/to/my.phar.bz2
$p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.phar already exists
?>
参见
- PharFileInfo::getCompressedSize() - 返回 Phar 存档中文件的实际大小(压缩)
- PharFileInfo::isCompressed() - 返回条目是否被压缩
- PharFileInfo::compress() - 使用 zlib 或 bzip2 压缩当前 Phar 条目
- PharFileInfo::d ecompress() - 解压缩 phar 中的当前 Phar 条目
- PharData::compress() - 使用 Gzip 或 Bzip2 压缩整个 tar/zip 压缩文件
- Phar::canCompress() - 返回 phar 扩展是否支持使用 zlib 或 bzip2 进行压缩
- Phar::isCompressed() - 如果压缩了整个 phar 存档(.tar.gz/tar.bz 等),则返回 Phar::GZ 或 PHAR::BZ2
- Phar::d ecompress() - 解压缩整个 Phar 存档
- Phar::getSupportedCompression() - 返回支持的压缩算法数组
- Phar::compressFiles() - 压缩当前 Phar 存档中的所有文件
- Phar::d ecompressFiles() - 解压缩当前 Phar 存档中的所有文件
更多建议: