Phar::compressFiles — Сжимает все файлы в текущем Phar-архиве

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

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

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

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

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

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

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

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

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

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

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

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

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

Phar::compressFiles объявляет результат типа void. Phar::compressFiles объявлена с результатом void. Проверяйте наблюдаемый эффект и диагностику вызова; присваивание результата не подтверждает успешность операции.

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

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

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

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

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

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

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

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

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

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

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

Для Phar::compressFiles базовый ориентир: сжимает все файлы в текущем phar-архиве; обязательные $compression; результат void. Совпадение имени compressFiles не делает методы взаимозаменяемыми: Phar::compressFiles принадлежит Phar, а PharData::compressFiles — PharData. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: PharData::compressFiles: сжать все файлы в текущем tar/zip-архиве; вход — обязательные $compression; результат — void. PharFileInfo::getCompressedSize: получить реальный занимаемый файлом размер на диске с учётом сжатия; вход — аргументов нет; результат — int. PharFileInfo::isCompressed: проверить, сжат ли файл; вход — необязательные $compression; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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