Home/ Manual/ phar / PharData/ PharData::delete

PharData::delete

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

Delete a file within a tar/zip archive

Description

PharData::delete(string $localName): true

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

Errors/Exceptions

Throws PharException if errors occur while flushing changes to disk.

Examples

A PharData::delete() example

php

<?php
try {
    $phar = new PharData('myphar.zip');
    $phar->delete('unlink/me.php');
    // this is equivalent to:
    unlink('phar://myphar.phar/unlink/me.php');
} catch (Exception $e) {
    // handle errors
}
?>