Php/docs/phar.offsetset
Phar::offsetSet
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0)
Phar::offsetSet — Set the contents of an internal file to those of an external file
Description
public Phar::offsetSet
( string $offset
, string $value
) : void
Note:
This method requires the
php.inisettingphar.readonlyto be set to0in order to work for Phar objects. Otherwise, a PharException will be thrown.
This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a Phar archive using array access brackets. offsetSet is used for modifying an existing file, or adding a new file to a Phar archive.
Parameters
offset- The filename (relative path) to modify in a Phar.
value- Content of the file.
Return Values
No return values.
Errors/Exceptions
if phar.readonly is 1,
BadMethodCallException is thrown, as modifying a Phar
is only allowed when phar.readonly is set to 0. Throws
PharException if there are any problems flushing
changes made to the Phar archive to disk.
Examples
Example #1 A Phar::offsetSet() example
offsetSet should not be accessed directly, but instead used
via array access with the [] operator.
<?php$p = new Phar('/path/to/my.phar', 0, 'my.phar');try { // calls offsetSet $p['file.txt'] = 'Hi there';} catch (Exception $e) { echo 'Could not modify file.txt:', $e;}?>
See Also
- Phar::offsetExists() - Determines whether a file exists in the phar
- Phar::offsetGet() - Gets a PharFileInfo object for a specific file
- Phar::offsetUnset() - Remove a file from a phar
