PharData::compressFiles

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

PharData::compressFiles — Compacta todos os arquivos no arquivo tar/zip atual

Descrição

public PharData::compressFiles(int $compression): void

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 compacta todos os arquivos usando a compactação especificada. As extensões zlib ou bzip2 devem estar habilitadas para aproveitar este recurso. Além disso, se algum arquivo já estiver compactado usando bzip2/zlib, a respectiva extensão deverá ser habilitada para descompactar os arquivos antes de compactar novamente.

Parâmetros

compression: A compactação. Deve ser Phar::GZ ou Phar::BZ2 para adicionar compactação; ou Phar::NONE para remover compactação.

Valor Retornado

Nenhum valor é retornado.

Erros/Exceções

Lança BadMethodCallException se a variável INI phar.readonly estiver ativada, 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::compressFiles()

<?php
$p = new Phar('/caminho/para/meu.phar', 0, 'meu.phar');
$p['meuarquivo.txt'] = 'olá';
$p['meuarquivo2.txt'] = 'olá';
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->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));
}
?>

O exemplo acima produzirá:

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

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::decompressFiles() - Descompacta todos os arquivos no arquivo 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