PharFileInfo::compress
(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)
PharFileInfo::compress — Сжать текущий файл с помощью zlib или bzip2
Описание
$compression
) : boolЭтот метод сжимает файл внутри phar-архива с помощью bzip2 или zlib. Для конкретных алгоритмов сжатия необходимо, чтобы были подключены расширения bzip2 или zlib соответственно.Также, если файл уже сжат, то для его расжатия потребуется соответствующее расширение. Так как данный функционал изменяет содержимое архива, для его нормальной работы необходимо, чтобы INI-опция phar.readonly была отключена, иначе не получится внести изменение в архив Phar. Файлы PharData не имеют ограничений, связанных с настройкой в php.ini.
Возвращаемые значения
Возвращает true в случае успешного завершения или false в случае возникновения ошибки.
Ошибки
Выбрасывает BadMethodCallException, если INI-опция phar.readonly включена, или если соответствующее расширение bzip2/zlib недоступно.
Примеры
Пример #1 Пример использовния PharFileInfo::compress()
<?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 'Операции создания/изменения на my.phar завершились ошибкой: ', $e;
}
?>
Результат выполнения данного примера:
bool(false) bool(true)
Смотрите также
- PharFileInfo::getCompressedSize() - Получить реальный занимаемый файлом размер на диске с учетом сжатия
- PharFileInfo::isCompressed() - Проверить, сжат ли файл
- PharFileInfo::decompress() - Расжимает текущий файл
- Phar::canCompress() - Проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2
- Phar::isCompressed() - Возвращает Phar::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее)
- Phar::compressFiles() - Сжимает все файлы в текущем Phar-архиве
- Phar::decompressFiles() - Распаковывает все файлы в текущем Phar-архиве
- Phar::compress() - Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия
- Phar::decompress() - Распаковывает весь Phar-архив
- Phar::getSupportedCompression() - Возвращает массив поддерживаемых алгоритмов сжатия