PharFileInfo::getMetadata
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)
Returns file-specific meta-data saved with a file
Description
PharFileInfo::getMetadata(array $unserializeOptions = []): mixed
Return meta-data that was saved in the Phar archive's manifest for this file.
Parameters
Return Values
any PHP variable that can be serialized and is stored as meta-data for the file, or null if no meta-data is stored.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | The parameter unserializeOptions has been added. |
Examples
A PharFileInfo::getMetadata() example
php
<?php
// make sure it doesn't exist
@unlink('brandnewphar.phar');
try {
$p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
$p['file.txt'] = 'hello';
$p['file.txt']->setMetadata(array('user' => 'bill', 'mime-type' => 'text/plain'));
var_dump($p['file.txt']->getMetadata());
} catch (Exception $e) {
echo 'Could not create/modify brandnewphar.phar: ', $e;
}
?>The above example will output:
output
array(2) {
["user"]=>
string(4) "bill"
["mime-type"]=>
string(10) "text/plain"
}