PharData::buildFromIterator
(No version information available, might be only in CVS)
PharData::buildFromIterator — Construct a tar or zip archive from an iterator.
Описание
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.
Примеры
Пример #1 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 file project.tar can then be used immediately. buildFromIterator() does not set values such as compression, metadata, and this can be done after creating the tar/zip archive.
As an interesting note, 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->createDefaultWebStub('cli/index.php', 'www/index.php'));
?>
Пример #2 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
Возвращаемые значения
buildFromIterator() returns an associative array mapping internal path of file to the full path of the file on the filesystem.
Errors/Exceptions
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.
- Add an empty directory to the tar/zip archive
- Add a file from the filesystem to the tar/zip archive
- Add a file from the filesystem to the tar/zip archive
- Construct a tar/zip archive from the files within a directory.
- Construct a tar or zip archive from an iterator.
- Compresses the entire tar/zip archive using Gzip or Bzip2 compression
- Compresses all files in the current tar/zip archive
- Construct a non-executable tar or zip archive object
- Convert a phar archive to a non-executable tar or zip file
- Convert a non-executable tar/zip archive to an executable phar archive
- Copy a file internal to the phar archive to another new file within the phar
- Decompresses the entire Phar archive
- Decompresses all files in the current zip archive
- Deletes the global metadata of a zip archive
- Delete a file within a tar/zip archive
- Extract the contents of a tar/zip archive to a directory
- Returns true if the tar/zip archive can be modified
- set the contents of a file within the tar/zip to those of an external file or string
- remove a file from a tar/zip archive
- dummy function (Phar::setAlias is not valid for PharData)
- dummy function (Phar::setDefaultStub is not valid for PharData)
- Sets phar archive meta-data
- set the signature algorithm for a phar and apply it. The
- dummy function (Phar::setStub is not valid for PharData)
Коментарии
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);
}
}