Phar::setMetadata

Sets phar archive meta-data

&reftitle.description; public `void` `Phar::setMetadata` `mixed` `metadata` &phar.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.

&reftitle.parameters;

`metadata`

- Any PHP variable containing information to store that describes the phar archive

&reftitle.returnvalues;

&return.void;

&reftitle.examples;

### A `Phar::setMetadata` example

    <?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;
    }
    ?>

&example.outputs;

    array(1) {
      ["bootstrap"]=>
      string(8) "file.php"
    }

&reftitle.seealso;

- `Phar::getMetadata`
- `Phar::delMetadata`
- `Phar::hasMetadata`