Phar::offsetUnset
Phar::offsetUnset
(PHP >= 5.3.0, PECL phar >= 1.0.0)
Phar::offsetUnset — remove a file from a phar
Description
public bool Phar::offsetUnset ( string $offset )
Note: This method requires the php.ini settingphar.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. offsetUnset is used for deleting an existing file, and is called by the unset() language construct.
Parameters
offset
The filename (relative path) to modify in a Phar.
Return Values
Returns TRUE on success or FALSE on failure.
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::offsetUnset() example
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar'
try {
// deletes file.txt from my.phar by calling offsetUnset
unset($p['file.txt']
} catch (Exception $e) {
echo 'Could not delete 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::offsetSet() - set the contents of an internal file to those of an external file
- Phar::unlinkArchive() - Completely remove a phar archive from disk and from memory
- Phar::delete() - Delete a file within a phar archive
← Phar::offsetSet
Phar::running →
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
