PHP8 PharData::compress
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
PharData::compress — 使用 Gzip 或 Bzip2 压缩压缩整个 tar/zip 压缩文件
说明
public PharData::compress(int $compression, ?string $extension = null): ?PharData
对于 tar 存档,此方法使用 gzip 压缩或 bzip2 压缩。生成的文件可以用 gunzip 命令/bunzip 命令,或使用 Phar 直接透明地访问 外延。
对于 zip 存档,此方法失败并出现异常。 必须启用 zlib 扩展才能压缩 使用 gzip 压缩时,bzip2 扩展名必须 启用以使用 bzip2 压缩进行压缩。
此外,如果传递给扩展名,此方法会自动重命名存档、追加或删除扩展名 删除压缩。或者,可以将文件扩展名指定为第二个 参数。.gz.bz2Phar::NONE
参数
compression
压缩必须是 之一,以添加压缩或删除压缩。
Phar::GZ
Phar::BZ2
Phar::NONE
extension
默认情况下,扩展名是 or 用于压缩 tar 和解压缩。
.tar.gz
.tar.bz2
.tar
返回值
成功后返回 PharData 对象, 或失败时为 null。
错误/异常
如果出现以下情况,则引发 BadMethodCallException ZLIB 扩展不可用,或者 BZIP2 扩展不可用 未启用。
更新日志
版本 | 说明 |
---|---|
8.0.0 | extension 现在是可为 null 的。 |
示例
示例 #1 A PharData::compress() example
<?php
$p = new PharData('/path/to/my.tar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p1 = $p->compress(Phar::GZ); // copies to /path/to/my.tar.gz
$p2 = $p->compress(Phar::BZ2); // copies to /path/to/my.tar.bz2
$p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.tar already exists
?>
参见
- Phar::compress() - 使用 Gzip 或 Bzip2 压缩整个 Phar 存档