PharData::extractTo

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

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

Опис

public PharData::extractTo(string $directory, array|string|null $files = null, bool $overwrite = false): bool

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

Параметри

directory: Path to extract the given files to
files: The name of a file or directory to extract, or an array of files/directories to extract
overwrite: Set to true to enable overwriting existing files

Значення, що повертаються

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.

Приклади

Приклад #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', null, true); // extract all files, and overwrite
} catch (Exception $e) {
    // handle errors
}
?>

Примітки

Зауваження:
Файлові системи Windows NTFS не підтримують використання деяких символів у назвах файлів, а саме <|>*?":. Не підтримуються також назви файлів з крапкою в кінці. На відміну від деяких інструментів розпакування, цей метод не замінює ці символи на підкреслення, а натомість не витягує такі файли.

Прогляньте також

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