Phar::buildFromIterator

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

    Phar::buildFromIterator — イテレータから phar アーカイブを作成する

    説明

    publicPhar::buildFromIterator(Traversable$iterator, ?string$baseDirectory = null): array

    注意:

    このメソッドは、php.ini の phar.readonly が 0 でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。

    phar アーカイブをイテレータから作成します。 サポートするイテレータは二種類で、 phar 内のファイル名とディスク上の実際のファイル名を対応させたものか、あるいは DirectoryIterator のように SplFileInfo オブジェクトを返すものです。 SplFileInfo オブジェクトを返すイテレータの場合は、2 番目のパラメータが必要となります。

    パラメータ

    iterator

    phar ファイルと実際の場所の関連を返すイテレータ、 あるいは SplFileInfo オブジェクトを返すイテレータ。

    baseDirectory

    SplFileInfo オブジェクトを返すイテレータを指定した際、 phar アーカイブへの追加時にフルパスから取り除く部分。

    戻り値

    Phar::buildFromIterator() は連想配列を返します。 これは、ファイルの内部パスとファイルシステム上のフルパスを対応させたものです。

    エラー / 例外

    このメソッドは、イテレータが間違った値 (たとえば文字列キーではなく整数キーなど) を返した場合に UnexpectedValueException を返します。また、SplFileInfo 型のイテレータを渡したときに baseDirectory を指定しなかった場合は BadMethodCallException を、 phar アーカイブの保存時にエラーが発生した場合は PharException を返します。

    変更履歴

    バージョン説明
    8.1.0Phar::buildFromIterator() は、 false を返さなくなりました。
    8.0.0baseDirectory は、nullable になりました。

    例

    例1 SplFileInfo を使用した Phar::buildFromIterator() の例

    ほとんどの phar アーカイブは、実際のディレクトリ構造を反映した形式になっています。 このような場合は 2 番目の方式が最適です。 たとえば、次のようなディレクトリ構成のファイルを含む phar アーカイブを作成してみることにしましょう。 

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

    次のコードを使用すると、これらのファイルを phar アーカイブ "project.phar" に追加します。

    <?php
    // "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 アーカイブを作成した後で行うことができます。

    興味深いことに、Phar::buildFromIterator() を使用して既存の phar アーカイブの中身をコピーすることもできます。 というのも Phar オブジェクトは DirectoryIterator を継承しているからです。

    <?php
    // "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() の例

    それ以外の形式のイテレータでは、 key => value の対応を返すものを使用できます。たとえば ArrayIterator などです。

    <?php
    // "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'));
    ?>

    参考

    To Top