Наша группа в телеграмм для обмена идеями, проектами, мыслями, людьми в сфере ИТ г.Ростова-на-Дону: @it_rostov


(PHP >= 5.3.0, PECL phar >= 2.0.0)

Phar::buildFromIterator — Construct a phar archive from an iterator.


public array Phar::buildFromIterator ( Iterator $iter [, string $base_directory ] )


Для корректной работы с объектами Phar этому методу необходима установка значения php.ini phar.readonly в 0. В противном случае, будет выброшено исключение PharException.

Populate a phar archive from an iterator. Two styles of iterators are supported, iterators that map the filename within the phar to the name of a file on disk, and iterators like DirectoryIterator that return SplFileInfo objects. For iterators that return SplFileInfo objects, the second parameter is required.

Список параметров

iter - Any iterator that either associatively maps phar file to location or returns SplFileInfo objects

base_directory - For iterators that return SplFileInfo objects, the portion of each file's full path to remove when adding to the phar archive

Возвращаемые значения

Phar::buildFromIterator() returns an associative array mapping internal path of file to the full path of the file on the filesystem.


Пример #1 A Phar::buildFromIterator() with SplFileInfo

For most phar archives, the archive will reflect an actual directory layout, and the second style is the most useful. For instance, to create a phar archive containing the files in this sample directory layout:

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

This code could be used to add these files to the "project.phar" phar archive:

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

The file project.phar can then be used immediately. Phar::buildFromIterator() does not set values such as compression, metadata, and this can be done after creating the phar archive.

As an interesting note, Phar::buildFromIterator() can also be used to copy the contents of an existing phar archive, as the Phar object descends from DirectoryIterator:

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

Пример #2 A Phar::buildFromIterator() with other iterators

The second form of the iterator can be used with any iterator that returns a key => value mapping, such as an ArrayIterator:

// create with alias "project.phar"
$phar = new Phar('project.phar', 0, 'project.phar');
    new ArrayIterator(
        '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'));


This method returns UnexpectedValueException when the iterator returns incorrect values, such as an integer key instead of a string, a BadMethodCallException when an SplFileInfo-based iterator is passed without a base_directory parameter, or a PharException if there were errors saving the phar archive.

Смотрите также

User Contributed Notes

There are no user contributed notes for this page.

Описание класса phar, примеры использования класса phar.

Описание на ru2.php.net
Описание на php.ru