Phar::compressFiles

(PHP >= 5.3.0, PECL phar >= 2.0.0)

Phar::compressFiles — Compresses all files in the current Phar archive

Описание

public void Phar::compressFiles ( int $compression )

Замечание:

Для корректной работы с объектами Phar этому методу необходима установка значения php.ini phar.readonly в 0. В противном случае, будет выброшено исключение PharException.

For tar-based phar archives, this method throws a BadMethodCallException, as compression of individual files within a tar archive is not supported by the file format. Use Phar::compress() to compress an entire tar-based phar archive.

For Zip-based and phar-based phar archives, this method compresses all files in the Phar archive using the specified compression. The zlib or bzip2 extensions must be enabled to take advantage of this feature. In addition, if any files are already compressed using bzip2/zlib compression, the respective extension must be enabled in order to decompress the files prior to re-compressing. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed.

Список параметров

compression - Compression must be one of Phar::GZ, Phar::BZ2 to add compression, or Phar::NONE to remove compression.

Возвращаемые значения

Эта функция не возвращает значения после выполнения.

Ошибки

Throws BadMethodCallException if the phar.readonly INI variable is on, the zlib extension is not available, or if any files are compressed using bzip2 compression and the bzip2 extension is not enabled.

Примеры

Пример #1 A Phar::compressFiles() example

$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
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));
}

Результат выполнения данного примера:

string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)
string(10) "myfile.txt"
int(4096)
bool(false)
bool(true)
string(11) "myfile2.txt"
int(4096)
bool(false)
bool(true)

Смотрите также

• PharFileInfo::getCompressedSize() - Returns the actual size of the file (with compression) inside the Phar archive
• PharFileInfo::isCompressed() - Returns whether the entry is compressed
• PharFileInfo::compress() - Compresses the current Phar entry with either zlib or bzip2 compression
• PharFileInfo::decompress() - Decompresses the current Phar entry within the phar
• Phar::canCompress() - Returns whether phar extension supports compression using either zlib or bzip2
• Phar::isCompressed() - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)
• Phar::decompressFiles() - Decompresses all files in the current Phar archive
• Phar::getSupportedCompression() - Return array of supported compression algorithms
• Phar::compress() - Compresses the entire Phar archive using Gzip or Bzip2 compression
• Phar::decompress() - Decompresses the entire Phar archive

User Contributed Notes 1 note

0
alex at phpguide dot co dot il ¶2 years ago

Compressing the entire archive
$phar->compress();
overrides your stub file.
Use compressFiles to have the the files compressed keeping your own stub in tact (which is not being compressed).
The compression is a little bit worth (since one file is left uncompressed), but enables you to have your own stub file executed with browser requests.
Don't get confused, compressing doesn't rise the security level of your code or obfuscating it strongly enough. The source code of your compressed phar is still easy to read.

Описание класса phar, примеры использования класса phar.

Описание на ru2.php.net
Описание на php.ru