CakeFest 2017 NYC, the Official CakePHP Conference


(PHP >= 5.3.0, PECL phar >= 2.0.0)

PharData::extractToExtract the contents of a tar/zip archive to a directory


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

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 second 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().



Path to extract the given files to


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


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.


Throws PharException if errors occur while flushing changes to disk.


Example #1 A PharData::extractTo() example

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

See Also

add a note add a note

User Contributed Notes 1 note

njh at aelius dot com
3 years ago
Note that PHAR only supports extracting the 'ustar' variant of the tar archives.

Some systems (such as older versions of Mac OS X) generate the 'pax' format by default.

See here for more information:
To Top