Phar::compress — Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия

Назначение Phar::compress

Phar::compress: Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия. Справочная сущность относится к разделу «phar». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается Phar::compress

Эта страница описывает член compress класса Phar, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $compression; необязательные $extension; объявленный результат — Phar|null.

Смысловое направление Phar::compress

Смысловое направление Phar::compress — «операция compress». В прикладном коде свяжите вызов Phar::compress с одним явно сформулированным результатом прикладного сценария. Контрольный набор для этой операции: проверьте штатное выполнение, граничное состояние и документированный отказ. Такой акцент отделяет Phar::compress от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура Phar::compress

Структурная запись: public Phar|null Phar::compress(int $compression, string|null $extension = null). В ней 2 параметра: обязательные $compression; необязательные $extension. Результат объявлен как Phar|null; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры Phar::compress

Порядок и роли аргументов по сигнатуре: 1. $compression — int, обязателен; 2. $extension — string|null, необязателен, default null.

Контроль входных данных для Phar::compress

1) int $compression — обязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 2) string|null $extension — необязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат Phar::compress

Phar::compress объявляет результат типа Phar|null. В результате Phar::compress присутствует null. Обрабатывайте его отдельной веткой и не используйте нестрогое сравнение, если другие допустимые значения могут быть пустыми.

Проверочный сценарий для Phar::compress

Подготовьте объект Phar в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором int $compression. Затем отдельно добавьте необязательные параметры string|null $extension=null, чтобы увидеть влияние значений по умолчанию. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

Интеграция Phar::compress в проект

Храните подготовку Phar и вызов Phar::compress в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «файловый ввод-вывод» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция Phar::compress не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика Phar::compress

Сначала запишите точную сигнатуру public Phar|null Phar::compress(int $compression, string|null $extension = null) и фактические типы переданных значений. Затем проверьте состояние экземпляра Phar непосредственно перед методом Phar::compress. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «файловый ввод-вывод» применяйте отдельный негативный тест: проверить отсутствие файла, права, пустой поток и частичное чтение. В production-коде важно нормализовать путь и ограничить доступ разрешённой областью. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать Phar::compress

Выбор Phar::compress оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к Phar; 2) сигнатура содержит 2 аргумента: обязательных 1, необязательных 1; 3) вызывающему коду нужен результат Phar|null и действие «операция compress». Для профиля «файловый ввод-вывод» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с PharData::compress: у него другое назначение, владелец или набор входных данных.

Сравнение Phar::compress с соседними API

Для Phar::compress базовый ориентир: сжимает весь phar-архив с помощью gzip- или bzip2-сжатия; обязательные $compression; необязательные $extension; результат Phar|null. Совпадение имени compress не делает методы взаимозаменяемыми: Phar::compress принадлежит Phar, а PharData::compress — PharData. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: PharData::compress: сжимает весь архив tar/zip, используя сжатие gzip или bzip2; вход — обязательные $compression; необязательные $extension; результат — PharData|null. PharFileInfo::compress: сжимает текущий файл методом zlib или bzip2; вход — обязательные $compression; результат — true. PharFileInfo::getCompressedSize: получить реальный занимаемый файлом размер на диске с учётом сжатия; вход — аргументов нет; результат — int. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 8.0.0. Phar::compress сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для Phar::compress.

Связанные материалы