PHP 8.3.4 Released!

PharFileInfo::compress

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

PharFileInfo::compressCompresses the current Phar entry with either zlib or bzip2 compression

Descrição

public PharFileInfo::compress(int $compression): bool

This method compresses the file inside the Phar archive using either bzip2 compression or zlib compression. The bzip2 or zlib extension must be enabled to take advantage of this feature. In addition, if the file is already compressed, the respective extension must be enabled in order to decompress the file. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed if the file is within a Phar archive. Files within PharData archives do not have this restriction.

Parâmetros

compression

Compression must be Phar::GZ or Phar::BZ2.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Erros/Exceções

Throws BadMethodCallException if the phar.readonly INI variable is on, or if the bzip2/zlib extension is not available.

Exemplos

Exemplo #1 A PharFileInfo::compress() example

<?php
try {
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$file = $p['myfile.txt'];
var_dump($file->isCompressed(Phar::BZ2));
$p['myfile.txt']->compress(Phar::BZ2);
var_dump($file->isCompressed(Phar::BZ2));
} catch (
Exception $e) {
echo
'Create/modify operations on my.phar failed: ', $e;
}
?>

O exemplo acima produzirá:

bool(false)
bool(true)

Veja Também

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top