PHP Conference Japan 2024

PharData::convertToExecutable

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

PharData::convertToExecutable将非可执行的 tar/zip 归档文件转换为可执行的 phar 归档文件

描述

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

注意:

此方法需要 php.ini 设置 phar.readonly 设置为 0 才能对 Phar 对象起作用。否则,将抛出 PharException

此方法用于将非可执行的 tar 或 zip 归档文件转换为可执行的 phar 归档文件。可以使用三种可执行文件格式(phar、tar 或 zip)中的任何一种,并且还可以执行整个归档文件的压缩。

如果未指定任何更改,则此方法将抛出 BadMethodCallException

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

参数

format

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

compression

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

extension

此参数用于覆盖转换后的归档文件的默认文件扩展名。请注意,所有基于 zip 和 tar 的 phar 归档文件都必须在其文件扩展名中包含 .phar 才能被处理为 phar 归档文件。

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

返回值

如果成功,该方法将返回一个 Phar 对象,否则返回 null

错误/异常

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

变更日志

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

示例

示例 #1 PharData::convertToExecutable() 示例

使用 PharData::convertToExecutable()

<?php
try {
$tarphar = new PharData('myphar.tar');
// 将其转换为 phar 文件格式
// 请注意,myphar.tar *不会* 被解除链接
$phar = $tarphar->convertToExecutable(Phar::PHAR); // 创建 myphar.phar
$phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
// 创建 myphar.phar.tgz
$compressed = $tarphar->convertToExecutable(Phar::TAR, Phar::GZ, '.phar.tgz');
} catch (
Exception $e) {
// 在此处处理错误
}
?>

参见

添加注释

用户贡献的注释

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