Phar::compressAllFilesGZ

(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0)

Phar::compressAllFilesGZ — Сжимает все файлы в текущем Phar-архиве с помощью Gzip-сжатия

Описание

public Phar::compressAllFilesGZ ( void ) : bool

Замечание:

Этот метод был удален из расширения phar, начиная с версии 2.0.0. Альтернативные реализации возможны с помощью функций Phar::compress(), Phar::decompress(), Phar::compressFiles() и Phar::decompressFiles().

Замечание:

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

В случае использования с phar-архивами, основанными на tar, этот метод сжимает весь архив целиком с помощью gzip-сжатия. Полученный файл может быть обработан с помощью команды gunzip; к нему также можно получить прямой доступ, используя модуль Phar.

В случае использования с phar-архивами, основанными на zip или phar, этот метод сжимает все файлы в Phar-архиве используя gzip-сжатие. Для возможности воспользоваться этой функцией должен быть включен модуль zlib. Кроме того, если какие-либо файлы в архиве уже сжаты с использованием bzip2-сжатия, то для их распаковки перед повторным gzip-сжатием должен быть включен модуль bzip2. Как и в случае с другим функционалом, модифицирующим содержание phar-архива, для успешной работы данного метода необходимо, чтобы INI-переменная phar.readonly была отключена.

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

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

Ошибки

Выбрасывает исключение BadMethodCallException, если INI-переменная phar.readonly включена, модуль zlib не доступен или если какие-либо файлы внутри архива были сжаты с использованием bzip2-сжатия и модуль bzip2 не включен.

Примеры

Пример #1 Пример использования Phar::compressAllFilesGZ()

<?php
$p = new Phar('/путь/к/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'привет';
$p['myfile2.txt'] = 'привет';
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressedBZIP2());
    var_dump($file->isCompressedGZ());
}
$p->compressAllFilesGZ();
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressedBZIP2());
    var_dump($file->isCompressedGZ());
}
?>

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

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

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