Phar::canCompress — Проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2

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

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

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

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

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

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

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

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

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

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

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

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

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

Phar::canCompress объявляет результат типа bool. Phar::canCompress возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

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

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

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

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

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

Сначала запишите точную сигнатуру final public static bool Phar::canCompress(int $compression = 0) и фактические типы переданных значений. Затем проверьте состояние экземпляра Phar непосредственно перед методом Phar::canCompress. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для Phar::canCompress базовый ориентир: проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2; необязательные $compression; результат bool. Сопоставление с опубликованными соседями: PharFileInfo::getCompressedSize: получить реальный занимаемый файлом размер на диске с учётом сжатия; вход — аргументов нет; результат — int. PharFileInfo::isCompressed: проверить, сжат ли файл; вход — необязательные $compression; результат — bool. PharFileInfo::compress: сжимает текущий файл методом zlib или bzip2; вход — обязательные $compression; результат — true. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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