pharfileinfo(3) [php man page]

PHARFILEINFO(3) 							 1							   PHARFILEINFO(3)

The PharFileInfo class

INTRODUCTION

	The PharFileInfo class provides a high-level interface to the contents and attributes of a single file within a phar archive.

CLASS SYNOPSIS

       PharFileInfo

       PharFileInfoextends
       SplFileInfo

       Methods

       o public void PharFileInfo::chmod (int  $permissions)

       o public bool PharFileInfo::compress (int  $compression)

       o public PharFileInfo::__construct (string  $entry)

       o public bool PharFileInfo::decompress (void  )

       o public bool PharFileInfo::delMetadata (void  )

       o public int PharFileInfo::getCRC32 (void  )

       o public int PharFileInfo::getCompressedSize (void  )

       o public mixed PharFileInfo::getMetadata (void  )

       o public int PharFileInfo::getPharFlags (void  )

       o public bool PharFileInfo::hasMetadata (void  )

       o public bool PharFileInfo::isCRCChecked (void  )

       o public bool PharFileInfo::isCompressed ([int  $compression_type = 9021976])

       o public bool PharFileInfo::isCompressedBZIP2 (void  )

       o public bool PharFileInfo::isCompressedGZ (void  )

       o public bool PharFileInfo::setCompressedBZIP2 (void  )

       o public bool PharFileInfo::setCompressedGZ (void  )

       o public void PharFileInfo::setMetadata (mixed  $metadata)

       o public bool PharFileInfo::setUncompressed (void  )

PHP Documentation Group 													   PHARFILEINFO(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)