phar.delmetadata(3) [php man page]

PHAR.DELMETADATA(3)							 1						       PHAR.DELMETADATA(3)

Phar::delMetadata - Deletes the global metadata of the phar

SYNOPSIS

       public bool Phar::delMetadata (void  )

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.

	Deletes the global metadata of the phar

PARAMETERS

RETURN VALUES

	returns TRUE on success, but it is better to check for thrown exception, and assume success if none is thrown.

ERRORS
/EXCEPTIONS
	Throws PharException if errors occur while flushing changes to disk.

EXAMPLES

       Example #1

	      A Phar.delMetaData(3) example

	      <?php
	      try {
		  $phar = new Phar('myphar.phar');
		  var_dump($phar->getMetadata());
		  $phar->setMetadata("hi there");
		  var_dump($phar->getMetadata());
		  $phar->delMetadata();
		  var_dump($phar->getMetadata());
	      } catch (Exception $e) {
		  // handle errors
	      }
	      ?>

	      The above example will output:

	      NULL
	      string(8) "hi there"
	      NULL

SEE ALSO

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

PHP Documentation Group 												       PHAR.DELMETADATA(3)

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)