PHAR.SETMETADATA(3)							 1						       PHAR.SETMETADATA(3)

Phar::setMetadata - Sets phar archive meta-data

SYNOPSIS

       public void Phar::setMetadata (mixed  $metadata)

DESCRIPTION

       Note

	      This  method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException
	      will be thrown.

       Phar.setMetadata(3) should be used to store customized data that describes something about the phar archive as a complete entity. PharFile-
       Info.setMetadata(3)  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

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

RETURN VALUES

	No value is returned.

EXAMPLES

       Example #1

	      A Phar.setMetadata(3) 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;
	      }
	      ?>

	      The above example will output:

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

SEE ALSO

       Phar.getMetadata(3), Phar.delMetadata(3), Phar.hasMetadata(3).

PHP Documentation Group 												       PHAR.SETMETADATA(3)