PharData::addFile
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
PharData::addFile — Add a file from the filesystem to the tar/zip archive
Description
$filename, ?string $localName = null): void
With this method, any file or URL can be added to the tar/zip archive. If
the optional second parameter localname is specified,
the file will be stored in the archive with that name, otherwise the
file parameter is used as the path to store within
the archive. URLs must have a localname or an exception is thrown.
This method is similar to ZipArchive::addFile().
Parameters
-
filename -
Full or relative path to a file on disk to be added to the phar archive.
-
localName -
Path that the file will be stored in the archive.
Return Values
no return value, exception is thrown on failure.
Changelog
| Version | Description |
|---|---|
| 8.0.0 |
localName is now nullable.
|
Examples
Example #1 A PharData::addFile() example
<?php
try {
$a = new PharData('/path/to/my.tar');
$a->addFile('/full/path/to/file');
// demonstrates how this file is stored
$b = $a['full/path/to/file']->getContent();
$a->addFile('/full/path/to/file', 'my/file.txt');
$c = $a['my/file.txt']->getContent();
// demonstrate URL usage
$a->addFile('http://www.example.com', 'example.html');
} catch (Exception $e) {
// handle errors here
}
?>
Notes
Note: PharData::addFile(), PharData::addFromString() and PharData::offsetSet() save a new phar archive each time they are called. If performance is a concern, PharData::buildFromDirectory() or PharData::buildFromIterator() should be used instead.
See Also
- PharData::offsetSet() - Set the contents of a file within the tar/zip to those of an external file or string
- Phar::addFile() - Add a file from the filesystem to the phar archive
- PharData::addFromString() - Add a file from the filesystem to the tar/zip archive
- PharData::addEmptyDir() - Add an empty directory to the tar/zip archive
