PharData::addFromString

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

PharData::addFromStringAdd a file from the filesystem to the tar/zip archive

Description

public PharData::addFromString(string $localName, string $contents): void

With this method, any string can be added to the tar/zip archive. The file will be stored in the archive with localname as its path. This method is similar to ZipArchive::addFromString().

Parameters

localName

Path that the file will be stored in the archive.

contents

The file contents to store

Return Values

no return value, exception is thrown on failure.

Examples

Example #1 A PharData::addFromString() example

<?php
try {
    
$a = new PharData('/path/to/my.tar');

    
$a->addFromString('path/to/file.txt''my simple file');
    
$b $a['path/to/file.txt']->getContent();

    
// to add contents from a stream handle for large files, use offsetSet()
    
$c fopen('/path/to/hugefile.bin');
    
$a['largefile.bin'] = $c;
    
fclose($c);
} 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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top