PharFileInfo::compress — Сжимает текущий файл методом zlib или bzip2

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

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

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

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

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

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

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

Структурная запись: public true PharFileInfo::compress(int $compression). В ней 1 параметр: обязательные $compression. Результат объявлен как true; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

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

Порядок и роли аргументов по сигнатуре: 1. $compression — int, обязателен. Для PharFileInfo::compress фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

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

1) int $compression — обязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки.

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

PharFileInfo::compress объявляет результат типа true. Результат PharFileInfo::compress имеет объявленный тип true. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

Подготовьте объект PharFileInfo в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором int $compression. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

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

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

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

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

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

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

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

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

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

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

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

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

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