Phar::delete

(No version information available, might be only in CVS)

Phar::delete — Delete a file within a phar archive

Description

int 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.

Return Values

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

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

}

?>