phar.setmetadata(3) [php man page]

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)

PHARFILEINFO.SETMETADATA(3)						 1					       PHARFILEINFO.SETMETADATA(3)

PharFileInfo::setMetadata - Sets file-specific meta-data saved with a file

SYNOPSIS

       public void PharFileInfo::setMetadata (mixed  $metadata)

DESCRIPTION

       PharFileInfo.setMetadata(3)  should  only  be  used to store customized data in a file that cannot be represented with existing information
       stored with a file. Meta-data can significantly slow down the performance of loading a phar archive if the data is large, or if	there  are
       many  files containing meta-data. It is important to note that file permissions are natively supported inside a phar; it is possible to set
       them with the PharFileInfo.chmod(3) method. As with all functionality that modifies the contents of a phar, the phar.readonly INI  variable
       must be off in order to succeed if the file is within a Phar archive. Files within PharData archives do not have this restriction.

	Some  possible	uses  for  meta-data include passing a user/group that should be set when a file is extracted from the phar to disk. Other
       uses could include explicitly specifying a MIME type to return. However, any useful data that describes a file, but should not be contained
       inside of it may be stored.

PARAMETERS

	      o $metadata
		- Any PHP variable containing information to store alongside a file

RETURN VALUES

	No value is returned.

EXAMPLES

       Example #1

	      A PharFileInfo.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.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 phar: ', $e;
	      }
	      ?>

	      The above example will output:

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

SEE ALSO

       PharFileInfo.hasMetadata(3),  PharFileInfo.getMetadata(3), PharFileInfo.delMetadata(3), Phar.setMetadata(3), Phar.hasMetadata(3), Phar.get-
       Metadata(3).

PHP Documentation Group 											       PHARFILEINFO.SETMETADATA(3)