PharData::buildFromIterator()
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
Construct a tar or zip archive from an iterator
说明
PharData::buildFromIterator(Iterator$iter[,string $base_directory]): array
Populate a tar or zip archive from an iterator. Two styles of iterators are supported, iterators that map the filename within the tar/zip 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.
范例
A PharData::buildFromIterator() with SplFileInfo
For most tar/zip archives, the archive will reflect an actual directory layout, and the second style is the most useful. For instance, to create a tar/zip 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.tar" tar archive:
<?php $phar = new PharData('project.tar'); $phar->buildFromIterator( new RecursiveIteratorIterator( new RecursiveDirectoryIterator('/path/to/project')), '/path/to/project'); ?>
The fileproject.tarcan then be used immediately.PharData::buildFromIterator() does not set values such as compression, metadata, and this can be done after creating the tar/zip archive.
As an interesting note,PharData::buildFromIterator() can also be used to copy the contents of an existing phar, tar or zip archive, as the PharData object descends from DirectoryIterator:
<?php $phar = new PharData('project.tar'); $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')); ?>
A PharData::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:
<?php $phar = new PharData('project.tar'); $phar->buildFromIterator( new ArrayIterator( array( 'internal/file.php' => dirname(__FILE__) . '/somefile.php', 'another/file.jpg' => fopen('/path/to/bigfile.jpg', 'rb'), ))); ?>
参数
- $iter
Any iterator that either associatively maps tar/zip 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 tar/zip archive
返回值
PharData::buildFromIterator() returns an associative array mapping internal path of file to the full path of the file on the filesystem.
错误/异常
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_directoryparameter, or a PharException if there were errors saving the phar archive.
参见
- Phar::buildFromIterator() Construct a phar archive from an iterator
The code in the first exemple doesn't work properly without the flag FilesystemIterator::SKIP_DOTS in the RecursiveDirectoryIterator (on a linux filesystem). So, to build a tar with a phar, I do (with two level of iteration here) : $pharTar = new \PharData($contentTar.".tar"); $firstLevelIterator = new \DirectoryIterator($this->inputPath); foreach ($firstLevelIterator as $fileInfo) { /* @var \SplFileInfo $fileInfo */ if (in_array($fileInfo->getFilename(), $allowedDirectory)) { $recursiveDirectoryIterator = new \RecursiveDirectoryIterator( $this->inputPath . DIRECTORY_SEPARATOR . $fileInfo->getFilename(), \FilesystemIterator::SKIP_DOTS); $pharTar->buildFromIterator(new \RecursiveIteratorIterator($recursiveDirectoryIterator), $this->inputPath); } }