PharData::decompress

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

PharData::decompress — Descomprime el archivo Phar completo

Descripción

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

Descomprime el archivo completo, si es un archivo tar.

Para los archivos Zip, este método falla y lanza una excepción. La extensión zlib debe estar activada para descomprimir un archivo comprimido con gzip y la extensión bzip2 debe estar disponible para descomprimir un archivo comprimido con bzip2.

Además, este método renombra automáticamente la extensión de archivo del archivo, .tar por defecto. De lo contrario, una extensión de archivo puede especificarse con el argumento extension.

Parámetros

extension: Para descomprimir, la extensión por defecto es .tar. Utilice este argumento para especificar otra extensión de archivo. Tenga en cuenta que solo los archivos ejecutables pueden contener .phar en su nombre de archivo.

Valores devueltos

Un objeto PharData es devuelto en caso de éxito, o null en caso de fallo.

Errores/Excepciones

Levanta una excepción BadMethodCallException si la extensión zlib no está disponible o si la extensión bzip2 no está activada.

Historial de cambios

Versión	Descripción
8.0.0	`extension` ahora es nullable.

Ejemplos

Ejemplo #1 Ejemplo con PharData::decompress()

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

Ver también

PharFileInfo::getCompressedSize() - Devuelve el tamaño actual (con compresión) del fichero dentro del archivo Phar
PharFileInfo::isCompressed() - Indica si la entrada está comprimida
PharFileInfo::compress() - Comprime la entrada Phar actual con una de las compresiones zlib o bzip2
PharFileInfo::decompress() - Descomprime la entrada Phar actual dentro del phar
PharData::compress() - Comprime el archivo tar/zip completo utilizando la compresión Gzip o Bzip2
Phar::canCompress() - Determina si la extensión phar soporta la compresión utilizando zip o bzip2
Phar::isCompressed() - Devuelve Phar::GZ o PHAR::BZ2 si el archivo completo está comprimido (.tar.gz/tar.bz, etc)
PharData::compress() - Comprime el archivo tar/zip completo utilizando la compresión Gzip o Bzip2
Phar::getSupportedCompression() - Devuelve un array de los algoritmos de compresión soportados
PharData::compressFiles() - Comprime todos los ficheros del archivo tar/zip actual
PharData::decompressFiles() - Descomprime todos los ficheros del archivo zip actual

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

pttlens at gmail dot com ¶

6 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