PharFileInfo::getMetadata

Returns file-specific meta-data saved with a file

&reftitle.description; public `mixed` `PharFileInfo::getMetadata` `array` `unserializeOptions`[]

Return meta-data that was saved in the Phar archive's manifest for this file.

&reftitle.parameters;

&reftitle.returnvalues;

any PHP variable that can be serialized and is stored as meta-data for the file, or &null; if no meta-data is stored.

&reftitle.changelog;

&Version; | &Description;
8.0.0 | The parameter `unserializeOptions` has been added.

&reftitle.examples;

### A `PharFileInfo::getMetadata` example

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

&example.outputs;

    array(2) {
      ["user"]=>
      string(4) "bill"
      ["mime-type"]=>
      string(10) "text/plain"
    }

&reftitle.seealso;

- `PharFileInfo::setMetadata`
- `PharFileInfo::hasMetadata`
- `PharFileInfo::delMetadata`
- `Phar::setMetadata`
- `Phar::hasMetadata`
- `Phar::getMetadata`