PharFileInfo::setCompressedGZ

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

PharFileInfo::setCompressedGZ — Сжатие файла в phar-архиве с использованием gz

Описание

public PharFileInfo::setCompressedGZ ( void ) : bool

Замечание:

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

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

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

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

Ошибки

Бросает BadMethodCallException если INI-опция phar.readonly включена, или если расширение zlib недоступно.

Примеры

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

<?php
try {
    $p = new Phar('/path/to/my.phar', 0, 'my.phar');
    $p['myfile.txt'] = 'hi';
    $file = $p['myfile.txt'];
    var_dump($file->isCompressedGZ());
    $p['myfile.txt']->setCompressedGZ();
    var_dump($file->isCompressedGZ());
} catch (Exception $e) {
    echo 'Операции создания/изменения на my.phar завершилось ошибкой: ', $e;
}
?>

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

bool(false)
bool(true)

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