PHP 8.4.0 RC4 available for testing

Phar::extractTo

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

Phar::extractToExtract the contents of a phar archive to a directory

Опис

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

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 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, null to skip this param

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 Phar::extractTo() 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
}
?>

Примітки

Зауваження:

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

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

add a note

User Contributed Notes 1 note

up
1
msucco at mac dot com
5 years ago
On the command line (*nix) you can use the following command to extract a phar file:

$ mkdir tmp && cd $_
$ phar extract -f ../file.phar
To Top