Phar::delete

(PHP >= 5.3.0, PECL phar >= 2.0.0)

Delete a file within a phar archive

public bool Phar::delete ( string $entry )

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:

entry

Path within an archive to the file to delete.

Returns:

returns TRUE on success, but it is better to check for thrown exception, and assume success if none is thrown.

Exception:

Throws PharException if errors occur while flushing changes to disk.

Examples:

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
}
?>