Sets phar archive meta-data

# PharData::setMetadata

(No version information available, might only be in Git)

PharData::setMetadata — Sets phar archive meta-data

### Beschreibung

public function PharData::setMetadata(mixed `$metadata`): void

> Hinweis:

> Diese Methode des Phar-Objekts funktioniert nur wenn die php.ini-Einstellung `phar.readonly` auf 0 gesetzt ist, sonst wird eine PharException geworfen.

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.

### Parameter-Liste

`metadata`

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

### Rückgabewerte

Es wird kein Wert zurückgegeben.

### Beispiele

Beispiel #1 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;
    }
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

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

### Siehe auch

- Phar::getMetadata() - Returns phar archive meta-data
- Phar::delMetadata() - Deletes the global metadata of the phar
- Phar::hasMetadata() - Returns whether phar has global meta-data

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open