Php/docs/phar.delete
Phar::delete
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
Phar::delete — Delete a file within a phar archive
Description
public Phar::delete
( string $entry
) : bool
Note:
This method requires the
php.ini
settingphar.readonly
to be set to0
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
entry
- Path within an archive to the file to delete.
Return Values
returns TRUE
on success, but it is better to check for thrown exception,
and assume success if none is thrown.
Examples
Example #1 A Phar::delete() example
<?phptry { $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() - Delete a file within a tar/zip archive
- Phar::unlinkArchive() - Completely remove a phar archive from disk and from memory