PharData::decompress

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

PharData::decompress — Распаковать весь Phar-архив

Описание

public PharData::decompress(?string $extension = null): ?PharData

Для архивов типа tar, этот метод распаковывает весь архив.

Для архивов типа Zip этот метод выбросит исключение. Для разжатия gzip-архивов должен быть включён модуль zlib, а для bzip2, соответственно, модуль bzip2.

Также этот метод автоматически меняет расширение файла, по умолчанию .tar. Расширение можно указать явно с помощью параметра extension.

Список параметров

extension: По умолчанию при распаковке файлу меняется расширение на .tar. С помощью этого параметра можно явно указать новое расширение. Будьте осторожны, только запускаемые архивы могут содержать .phar в своих именах.

Возвращаемые значения

Возвращает объект типа PharData в случае успешного выполнения и null в случае возникновения ошибки.

Ошибки

Выбрасывает исключение BadMethodCallException, если отсутствует модуль, необходимый для распаковки: zlib или bzip2.

Список изменений

Версия	Описание
8.0.0	`extension` теперь допускает значение null.

Примеры

Пример #1 Пример использования PharData::decompress()

<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // creates /path/to/my.tar
?>

Смотрите также

PharFileInfo::getCompressedSize() - Получить реальный занимаемый файлом размер на диске с учётом сжатия
PharFileInfo::isCompressed() - Проверить, сжат ли файл
PharFileInfo::compress() - Сжать текущий файл с помощью zlib или bzip2
PharFileInfo::decompress() - Разжимает текущий файл
PharData::compress() - Сжимает весь архив tar/zip, используя сжатие Gzip или Bzip2
Phar::canCompress() - Проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2
Phar::isCompressed() - Возвращает Phar::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее)
PharData::compress() - Сжимает весь архив tar/zip, используя сжатие Gzip или Bzip2
Phar::getSupportedCompression() - Возвращает массив поддерживаемых алгоритмов сжатия
PharData::compressFiles() - Сжать все файлы в текущем tar/zip-архиве
PharData::decompressFiles() - Распаковать все файлы в текущем zip-архиве

add a note

User Contributed Notes 1 note

down

pttlens at gmail dot com ¶

5 years ago


If filename contains multiple dots(.), you can preserve other parts by following code (example1).

Example #1 (Expected)
<?php
$filename = "abc.xyz.tar.gz";
$p = new PharData($filename);
$exts = explode('.', $filename);
array_shift($exts);
array_pop($exts);
$ext = implode('.', $exts);
$p->decompress($ext); # result filename: abc.xyz.tar
?>

Example #2 (might be unexpected)
<?php
$filename = "abc.xyz.tar.gz";
$p = new PharData($filename);
$p->decompress($filename); # result filename: abc.tar; xyz is truncated accidentally.
?>

add a note