PharData::decompressFiles

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

PharData::decompressFiles — Descompacta todos os arquivos no arquivo zip atual

Descrição

public PharData::decompressFiles(): true

Nota:
Este método requer que a configuração phar.readonly do php.ini seja definida como 0 para funcionar com objetos Phar. Caso contrário, uma exceção PharException será lançada.

Para arquivos baseados em tar, este método lança uma BadMethodCallException, pois a compactação de arquivos individuais dentro de um arquivo tar não é suportada pelo formato de arquivo. Use PharData::compress() para compactar um arquivo inteiro baseado em tar.

Para arquivos Zip, este método descompacta todos os arquivos no arquivo. As extensões zlib ou bzip2 devem ser habilitadas para aproveitar este recurso se algum arquivo for compactado usando bzip2/zlib.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Sempre retorna true.

Erros/Exceções

Lança BadMethodCallException se a extensão zlib não estiver disponível ou se algum arquivo estiver compactado usando a bzip2 e a extensão bzip2 não estiver habilitada.

Exemplos

Exemplo #1 Um exemplo de PharData::decompressFiles()

<?php
$p = new PharData('/caminho/para/meu.zip');
$p['meuarquivo.txt'] = 'olá';
$p['meuarquivo2.txt'] = 'olá';
$p->compressFiles(Phar::GZ);
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
$p->decompressFiles();
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
?>

O exemplo acima produzirá:

string(14) "meuarquivo.txt"
int(4096)
bool(false)
bool(true)
string(15) "meuarquivo2.txt"
int(4096)
bool(false)
bool(true)
string(14) "meuarquivo.txt"
bool(false)
bool(false)
bool(false)
string(15) "meuarquivo2.txt"
bool(false)
bool(false)
bool(false)

Veja Também

PharFileInfo::getCompressedSize() - Retorna o tamanho real do arquivo (com compactação) dentro do arquivo Phar
PharFileInfo::isCompressed() - Informa se a entrada está compactada
PharFileInfo::compress() - Compacta a entrada Phar atual com zlib ou bzip2
PharFileInfo::decompress() - Descompacta a entrada Phar atual dentro do phar
Phar::canCompress() - Retorna se a extensão phar suporta compactação usando zlib ou bzip2
Phar::isCompressed() - Retorna Phar::GZ ou PHAR::BZ2 se todo o arquivo phar estiver compactado (.tar.gz/tar.bz e assim por diante)
PharData::compressFiles() - Compacta todos os arquivos no arquivo tar/zip atual
Phar::getSupportedCompression() - Retorna um array de algoritmos de compactação suportados
PharData::compress() - Compacta todo o arquivo tar/zip usando Gzip ou Bzip2
PharData::decompress() - Descompacta todo o arquivo Phar