Documentation PHP

PharData::extractTo

(No version information available, might be only in CVS)

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

Description

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

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

Liste de paramètres

pathto

Path within an archive to the file to delete.

files

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

overwrite

FALSE by default, set to TRUE to enable overwriting existing files

Valeurs de retour

returns TRUE on success, but it is better to check for thrown exception, and assume success if none is thrown.

Erreurs / Exceptions

Throws PharException if errors occur while flushing changes to disk.

Exemples

Exemple #1 A PharData::extractTo() 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'nulltrue); // extract all files, and overwrite
} catch (Exception $e) {
    
// handle errors
}
?>

Voir aussi



Ceci n'est pas la documentation originale du langage de programmation php, pour y accéder visiter le site www.php.net

Support du web, outils, services, compteurs, scripts, générateurs et autres outils pour les webmasters gratuitement à 100%
Page générée en 0.018542 secondes.