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)

PHAR.EXTRACTTO(3)							 1							 PHAR.EXTRACTTO(3)

Phar::extractTo - Extract the contents of a phar archive to a directory

SYNOPSIS

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

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.

	Extract all files within a phar 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 within an archive to the file to delete.

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

	      <?php
	      try {
		  $phar = new Phar('myphar.phar');
		  $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

       PharData.extractTo(3).

PHP Documentation Group 													 PHAR.EXTRACTTO(3)