array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'phardata.compress.php', 1 => 'PharData::compress', 2 => 'Compacta todo o arquivo tar/zip usando Gzip ou Bzip2', ), 'up' => array ( 0 => 'class.phardata.php', 1 => 'PharData', ), 'prev' => array ( 0 => 'phardata.buildfromiterator.php', 1 => 'PharData::buildFromIterator', ), 'next' => array ( 0 => 'phardata.compressfiles.php', 1 => 'PharData::compressFiles', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/phar/PharData/compress.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

PharData::compress

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

PharData::compress — Compacta todo o arquivo tar/zip usando Gzip ou Bzip2

Descrição

public PharData::compress(int $compression, ?string $extension = null): ?PharData

Para arquivos tar, este método compacta o arquivo inteiro usando gzip ou bzip2. O arquivo resultante pode ser processado com o comando gunzip/comando bunzip ou acessado direta e transparentemente com a extensão Phar.

Para arquivos zip, este método falha com uma exceção. A extensão zlib deve estar habilitada para compactar com gzip, a extensão bzip2 deve estar habilitada para compactar com bzip2.

Além disso, este método renomeia automaticamente o arquivo, anexando .gz, .bz2 ou removendo a extensão se Phar::NONE for passado para remover a compactação. Alternativamente, uma extensão de arquivo pode ser especificada com o segundo parâmetro.

Parâmetros

compression

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

extension

Por padrão, a extensão é .tar.gz ou .tar.bz2 para compactar um tar e .tar para descompactar.

Valor Retornado

Um objeto PharData é retornado em caso de sucesso, ou null em caso de falha.

Erros/Exceções

Lança BadMethodCallException se a extensão zlib não estiver disponível ou se a extensão bzip2 não estiver habilitada.

Registro de Alterações

Versão Descrição
8.0.0 extension agora é anulável.

Exemplos

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

<?php
$p = new PharData('/caminho/para/meu.tar');
$p['meuarquivo.txt'] = 'olá';
$p['meuarquivo2.txt'] = 'olá';
$p1 = $p->compress(Phar::GZ); // copia para /caminho/para/meu.tar.gz
$p2 = $p->compress(Phar::BZ2); // copia para /caminho/para/meu.tar.bz2
$p3 = $p2->compress(Phar::NONE); // exceção: /caminho/para/meu.tar já existe
?>

Veja Também