PHP8 Phar::createDefaultStub
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
Phar::createDefaultStub — 创建特定于 phar 文件格式的存根
说明
final public static Phar::createDefaultStub(?string $index = null, ?string $webIndex = null): string
此方法用于创建特定于 phar 文件格式的存根,并且是 不适用于基于 tar 或 zip 的 phar 存档。
Phar 存档包含一个引导加载程序,或者用 PHP 编写,当存档在 PHP 中执行时,通过 包括:stub
<?php
include 'myphar.phar';
?>
或通过简单执行:
php myphar.phar
此方法提供了一种简单易行的方法来创建存根,该存根将 从 Phar 存档运行启动文件。此外,不同的文件可以 指定从命令行运行 phar 归档文件,而不是通过 Web 服务器。加载器存根还调用 Phar::interceptFileFuncs() 以允许轻松捆绑访问文件系统的 PHP 应用程序。如果 PHAR 扩展不存在,加载器存根将提取 PHAR 存档 复制到临时目录,然后对文件进行操作。关机功能 在退出时擦除临时文件。
参数
index
phar 存档中要运行的相对路径(如果在命令行上访问)
webIndex
phar 存档中要运行的相对路径(如果通过 Web 浏览器访问)
返回值
返回一个字符串,其中包含自定义引导加载程序(存根)的内容 允许创建的 Phar 存档使用或不使用 Phar 扩展 启用。
错误/异常
如果任一参数较长,则引发 UnexpectedValueException 超过 400 字节。
更新日志
版本 | 说明 |
---|---|
8.0.0 | index 并且现在是可为 null 的。webIndex |
示例
示例 #1 A Phar::createDefaultStub() example
<?php
try {
$phar = new Phar('myphar.phar');
$phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
// handle errors
}
?>
参见
- Phar::setStub() - 用于设置 Phar 存档的 PHP 加载器或引导存根
- Phar::getStub() - 返回 Phar 存档的 PHP 加载器或引导存根