phar.getmetadata(3) [php man page]

PHAR.GETMETADATA(3)							 1						       PHAR.GETMETADATA(3)

Phar::getMetadata - Returns phar archive meta-data

SYNOPSIS

       public mixed Phar::getMetadata (void  )

DESCRIPTION

	Retrieve archive meta-data. Meta-data can be any PHP variable that can be serialized.

PARAMETERS

	No parameters.

RETURN VALUES

	any PHP variable that can be serialized and is stored as meta-data for the Phar archive, or NULL if no meta-data is stored.

EXAMPLES

       Example #1

	      A Phar.getMetadata(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 modify phar:', $e;
	      }
	      ?>

	      The above example will output:

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

SEE ALSO

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

PHP Documentation Group 												       PHAR.GETMETADATA(3)

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)