PharData::setMetadata
PHP function
Edit on GitHub ✎
Sets phar archive meta-data
Description
PharData::setMetadata(mixed $metadata): void
Write
Phar::setMetadata() should be used to store customized data that describes something about the phar archive as a complete entity. PharFileInfo::setMetadata() should be used for file-specific meta-data. Meta-data can slow down the performance of loading a phar archive if the data is large.
Some possible uses for meta-data include specifying which file within the archive should be used to bootstrap the archive, or the location of a file manifest like PEAR's package.xml file. However, any useful data that describes the phar archive may be stored.
Parameters
metadataAny PHP variable containing information to store that describes the phar archive
Return Values
Void
Examples
A Phar::setMetadata() 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.php'] = '<?php echo "hello"';
$p->setMetadata(array('bootstrap' => 'file.php'));
var_dump($p->getMetadata());
} catch (Exception $e) {
echo 'Could not create and/or modify phar:', $e;
}
?>The above example will output:
output
array(1) {
["bootstrap"]=>
string(8) "file.php"
}