phardata.extractto(3) [php man page]

PHARDATA.EXTRACTTO(3)							 1						     PHARDATA.EXTRACTTO(3)

PharData::extractTo - Extract the contents of a tar/zip archive to a directory

SYNOPSIS

       bool PharData::extractTo (string  $pathto, [string|array  $files], [bool  $overwrite = false])

DESCRIPTION

	Extract  all  files  within  a tar/zip archive to disk. Extracted files and directories preserve permissions as stored in the archive. The
       optional parameters allow optional control over which files are extracted, and whether existing files on disk can be overwritten. The  sec-
       ond  parameter files can be either the name of a file or directory to extract, or an array of names of files and directories to extract. By
       default, this method will not overwrite existing files, the third parameter can be set to true to enable overwriting of files. This  method
       is similar to ZipArchive.extractTo(3).

PARAMETERS

	      o $pathto
		- Path to extract the given files to

	      o $files
		- The name of a file or directory to extract, or an array of files/directories to extract

	      o $overwrite
		- Set to TRUE to enable overwriting existing files

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 PharData.extractTo(3) example

	      <?php
	      try {
		  $phar = new PharData('myphar.tar');
		  $phar->extractTo('/full/path'); // extract all files
		  $phar->extractTo('/another/path', 'file.txt'); // extract only file.txt
		  $phar->extractTo('/this/path',
		      array('file1.txt', 'file2.txt')); // extract 2 files only
		  $phar->extractTo('/third/path', null, true); // extract all files, and overwrite
	      } catch (Exception $e) {
		  // handle errors
	      }
	      ?>

SEE ALSO

       Phar.extractTo(3).

PHP Documentation Group 												     PHARDATA.EXTRACTTO(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)