PHP8 Phar::buildFromIterator

2024-02-20 09:16 更新

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

Phar::buildFromIterator — 从迭代器构造 phar 存档

说明

public Phar::buildFromIterator(Traversable $iterator, ?string $baseDirectory = null): array
注意:此方法需要 将 中的 设为 以适合 Phar 对象. 否则, 将抛出PharException.php.iniphar.readonly0

从迭代器填充 phar 存档。支持两种样式的迭代器, 将 phar 中的文件名映射到磁盘上文件名的迭代器, 以及返回的迭代器,如 DirectoryIterator SplFileInfo 对象。对于返回 SplFileInfo 对象的迭代器,第二个 参数是必需的。

参数

iterator

任何将 phar 文件关联映射到位置或 返回 SplFileInfo 对象

baseDirectory

对于返回 SplFileInfo 对象的迭代器,每个对象的部分 添加到 Phar 存档时要删除的文件的完整路径

返回值

Phar::buildFromIterator() 返回一个关联数组 将文件的内部路径映射到 文件系统。

错误/异常

此方法返回 UnexpectedValueException,当 迭代器返回不正确的值,例如整数键而不是 string,当 基于 SplFileInfo 的迭代器在不带参数的情况下传递,如果存在错误,则传递 PharException 保存 Phar 存档。baseDirectory

更新日志

版本说明
8.1.0Phar::buildFromIterator() 不再返回 false
8.0.0baseDirectory现在是可为 null 的。

示例

示例 #1 A Phar::buildFromIterator() with SplFileInfo

对于大多数 phar 存档,存档将反映实际的目录布局,并且 第二种样式是最有用的。例如,创建一个 phar 存档 包含此示例目录布局中的文件:

/path/to/project/
                 config/
                        dist.xml
                        debug.xml
                 lib/
                     file1.php
                     file2.php
                 src/
                     processthing.php
                 www/
                     index.php
                 cli/
                     index.php

此代码可用于将这些文件添加到“project.phar”phar 存档中:

<?php
// create with alias "project.phar"
$phar = new Phar('project.phar', 0, 'project.phar');
$phar->buildFromIterator(
    new RecursiveIteratorIterator(
     new RecursiveDirectoryIterator('/path/to/project')),
    '/path/to/project');
$phar->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));
?>

然后可以立即使用文件 project.phar。Phar::buildFromIterator() 没有 设置压缩、元数据等值,这可以在创建 法尔档案。

有趣的是,Phar::buildFromIterator() 也可以用于 复制现有 Phar 存档的内容,因为 Phar 对象下降 来自 DirectoryIterator:

<?php
// create with alias "project.phar"
$phar = new Phar('project.phar', 0, 'project.phar');
$phar->buildFromIterator(
    new RecursiveIteratorIterator(
     new Phar('/path/to/anotherphar.phar')),
    'phar:///path/to/anotherphar.phar/path/to/project');
$phar->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));
?>

示例 #2 带有其他迭代器的 Phar::buildFromIterator()

迭代器的第二种形式可以与任何返回的迭代器一起使用 键 => 值映射,例如 ArrayIterator:

<?php
// create with alias "project.phar"
$phar = new Phar('project.phar', 0, 'project.phar');
$phar->buildFromIterator(
    new ArrayIterator(
     array(
        'internal/file.php' => dirname(__FILE__) . '/somefile.php',
        'another/file.jpg' => fopen('/path/to/bigfile.jpg', 'rb'),
     )));
$phar->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));
?>

参见

  • Phar::buildFromDirectory() - 从目录中的文件构建 phar 存档


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号