PHP 8.4.2 Released!

PharFileInfo::delMetadata

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

PharFileInfo::delMetadataDeletes the metadata of the entry

Description

public PharFileInfo::delMetadata(): true

Deletes the metadata of the entry, if any.

Parameters

No parameters.

Return Values

Always returns true. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed if the file is within a Phar archive. Files within PharData archives do not have this restriction.

Errors/Exceptions

Throws PharException if errors occurred while flushing changes to disk, and BadMethodCallException if write access is disabled.

Examples

Example #1 A PharFileInfo::delMetaData() example

<?php
try {
$a = new Phar('myphar.phar');
$a['hi'] = 'hi';
var_dump($a['hi']->delMetadata());
$a['hi']->setMetadata('there');
var_dump($a['hi']->delMetadata());
var_dump($a['hi']->delMetadata());
} catch (
Exception $e) {
// handle errors
}
?>

The above example will output:

bool(false)
bool(true)
bool(false)

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top