Phar::delete
Delete a file within a phar archive
Description
public true Phar::delete(string $localName)
Note:
This
method requires the php.ini setting phar.readonly to be
set to 0 in order to work for Phar
objects. Otherwise, a PharException will be thrown.
Delete a file within an archive. This is the functional equivalent of
calling unlink on the stream wrapper equivalent,
as shown in the example below.
Parameters
-
localName
-
Path within an archive to the file to delete.
Return Values
Always returns true.
Errors/Exceptions
Throws PharException if errors occur while flushing
changes to disk.
Examples
Example #1 A Phar::delete example
<?php
try {
$phar = new Phar('myphar.phar');
$phar->delete('unlink/me.php');
// this is equivalent to:
unlink('phar://myphar.phar/unlink/me.php');
} catch (Exception $e) {
// handle errors
}
?>
See Also
- PharData::delete
- Phar::unlinkArchive