Phar::compress
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
Phar::compress — Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия
Описание
Замечание:
Для корректной работы с объектами Phar
этому методу необходима установка значения php.ini phar.readonly
в 0
.
В противном случае, будет выброшено исключение PharException.
В случае использования с phar-архивами, основанными на tar или phar, этот метод сжимает весь архив,
используя gzip- или bzip2-сжатие. Полученный файл может быть обработан одной из команд
gunzip/bunzip; к нему также можно получить прямой доступ, используя модуль Phar.
В случае использования с phar-архивами, основанными на zip, вызов этого метода потерпит неудачу и будет
брошено исключение. Для сжатия по алгоритму gzip должен быть включён модуль
zlib. Для сжатия по алгоритму bzip2 должен быть включён модуль
bzip2. Как и в случае с другим функционалом,
модифицирующим содержание phar-архива, для успешной работы данного метода необходимо,
чтобы INI-переменная phar.readonly была отключена.
Кроме того, этот метод автоматически переименовывает архив, добавляя .gz
,
.bz2
или удаляя расширение, если в качестве первого параметра был передан
Phar::NONE
, сообщающий о необходимости распаковки. В качестве альтернативы
расширение файла может быть задано с помощью второго параметра.
Список параметров
compression
-
Сжатие должно быть определено одной из констант: Phar::GZ
,
Phar::BZ2
для использования соответствующего алгоритма сжатия, или
Phar::NONE
для распаковки.
extension
-
Для сжатия phar-архивов по умолчанию используется расширение
.phar.gz
или .phar.bz2
, а
для сжатия tar-архивов — .phar.tar.gz
или
.phar.tar.bz2
. В случае распаковки, расширениями по
умолчанию являются .phar
и .phar.tar
.
Возвращаемые значения
Возвращает объект Phar или null
в случае возникновения ошибки.
Примеры
Пример #1 Пример использования Phar::compress()
<?php
$p = new Phar('/путь/к/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'привет';
$p['myfile2.txt'] = 'привет';
$p1 = $p->compress(Phar::GZ); // копирует в /путь/к/my.phar.gz
$p2 = $p->compress(Phar::BZ2); // копирует в /путь/к/my.phar.bz2
$p3 = $p2->compress(Phar::NONE); // исключение: /путь/к/my.phar уже существует
?>