PharData::delMetadata

(PHP >= 5.3.0, PECL phar >= 2.0.0)
Deletes the global metadata of a zip archive
bool PharData::delMetadata ( void )

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.

Deletes the global metadata of the zip archive

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 PharData::delMetaData() example
1
2
3
4
5
6
7
8
9
10
11
12
<?php
try {
    $phar new PharData('myphar.zip');
    var_dump($phar->getMetadata());
    $phar->setMetadata("hi there");
    var_dump($phar->getMetadata());
    $phar->delMetadata();
    var_dump($phar->getMetadata());
catch (Exception $e) {
    // handle errors
}
?>

The above example will output:

NULL
string(8) "hi there"
NULL
See also:

Phar::delMetadata() -

doc_php
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.