PHP Conference Japan 2024

Phar::convertToData

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

Phar::convertToData将 phar 归档文件转换为不可执行的 tar 或 zip 文件

描述

public Phar::convertToData(?int $format = null, ?int $compression = null, ?string $extension = null): ?PharData

此方法用于将可执行的 phar 归档文件转换为 tar 或 zip 文件。为了使 tar 或 zip 不可执行,phar 存根和 phar 别名文件将从新创建的归档文件中删除。

如果未指定任何更改,则如果归档文件为 phar 文件格式,此方法将抛出 BadMethodCallException。对于 tar 或 zip 文件格式的归档文件,此方法会将归档文件转换为不可执行的归档文件。

如果成功,该方法会在磁盘上创建一个新的归档文件并返回一个 PharData 对象。旧归档文件不会从磁盘中删除,应在进程完成后手动删除。

参数

format

这应该是 Phar::TARPhar::ZIP 之一。如果设置为 null,则将保留现有的文件格式。

compression

这应该是 Phar::NONE(表示不进行整个归档文件的压缩)、Phar::GZ(表示基于 zlib 的压缩)和 Phar::BZ2(表示基于 bzip 的压缩)之一。

extension

此参数用于覆盖转换后的归档文件的默认文件扩展名。请注意,对于不可执行的 tar 或 zip 归档文件,文件名中不能使用 .phar

如果转换为基于 tar 的 phar 归档文件,则默认扩展名分别为 .tar.tar.gz.tar.bz2,具体取决于指定的压缩方式。对于基于 zip 的归档文件,默认扩展名为 .zip

返回值

如果成功,此方法返回一个 PharData 对象,否则返回 null

错误/异常

当无法压缩、指定了未知的压缩方法、请求的归档文件正在使用 Phar::startBuffering() 进行缓冲且尚未使用 Phar::stopBuffering() 结束以及在 phar 创建过程中遇到任何问题时,此方法会抛出 BadMethodCallExceptionPharException

变更日志

版本 描述
8.0.0 formatcompressionextension 现在可以为 null。

示例

示例 #1 Phar::convertToData() 示例

使用 Phar::convertToData()

<?php
try {
$tarphar = new Phar('myphar.phar.tar');
// 请注意,myphar.phar.tar *不会* 被解除链接
// 将其转换为不可执行的 tar 文件格式
// 创建 myphar.tar
$tar = $tarphar->convertToData();
// 转换为不可执行的 zip 格式,创建 myphar.zip
$zip = $tarphar->convertToData(Phar::ZIP);
// 创建 myphar.tbz
$tgz = $tarphar->convertToData(Phar::TAR, Phar::BZ2, '.tbz');
// 创建 myphar.phar.tgz
$phar = $tarphar->convertToData(Phar::PHAR); // 抛出异常
} catch (Exception $e) {
// 在此处处理错误
}
?>

参见

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top