Phar::convertToExecutable

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

Phar::convertToExecutable将 phar 存档转换为其他可执行的 phar 存档文件格式

描述

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

注意:

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

此方法用于将 phar 存档转换为其他文件格式。例如,它可以用于从基于 zip 的可执行 phar 存档或从 phar 文件格式的可执行 phar 存档创建基于 tar 的可执行 phar 存档。此外,它可以用于将整个存档压缩应用于基于 tar 或 phar 的存档。

如果未指定任何更改,此方法将抛出 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

错误/异常

此方法在无法压缩时抛出 BadMethodCallException,指定了未知的压缩方法,请求的存档正在使用 Phar::startBuffering() 进行缓冲并且尚未使用 Phar::stopBuffering() 完成,如果写入支持被禁用,则抛出 UnexpectedValueException,如果在 phar 创建过程中遇到任何问题,则抛出 PharException

变更日志

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

范例

范例 #1 一个 Phar::convertToExecutable() 例子

使用 Phar::convertToExecutable()

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

参见

添加注释

用户贡献的注释 1 个注释

alex at phpguide dot co dot il
13 年前
转换为可执行文件和压缩方法会覆盖您使用其自己的代码段创建的任何代码段,该代码段负责提取/执行自身的內容。

在转换为可执行文件之后调用 setStub() 也没有帮助。就 php 5.3.6(phar 2.0.1)而言,如果您希望通过网络访问 phar 存档,您需要创建自己的
index.php 它将包含一个不可执行的 phar 并充当引导程序。
To Top