ZipArchive::addFile — Добавляет в ZIP-архив файл по заданному пути

Назначение ZipArchive::addFile

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

Чем отличается ZipArchive::addFile

Эта страница описывает член addFile класса ZipArchive, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $filepath; необязательные $entryname, $start, $length, $flags; объявленный результат — bool.

Смысловое направление ZipArchive::addFile

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

Сигнатура ZipArchive::addFile

Структурная запись: public bool ZipArchive::addFile(string $filepath, string $entryname = "", int $start = 0, int $length = ZipArchive::LENGTH_TO_END, int $flags = ZipArchive::FL_OVERWRITE). В ней 5 параметров: обязательные $filepath; необязательные $entryname, $start, $length, $flags. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ZipArchive::addFile

Порядок и роли аргументов по сигнатуре: 1. $filepath — string, обязателен; 2. $entryname — string, необязателен, default ""; 3. $start — int, необязателен, default 0; 4. $length — int, необязателен, default ZipArchive::LENGTH_TO_END; 5. $flags — int, необязателен, default ZipArchive::FL_OVERWRITE.

Контроль входных данных для ZipArchive::addFile

1) string $filepath — обязательный: нормализуйте представление, проверьте допустимую схему или базовый каталог и отдельно испытайте отсутствующую цель. 2) string $entryname — необязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) int $start — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 4) int $length — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 5) int $flags — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию.

Результат ZipArchive::addFile

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

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

Подготовьте объект ZipArchive в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором string $filepath. Затем отдельно добавьте необязательные параметры string $entryname="", int $start=0, int $length=ZipArchive::LENGTH_TO_END, int $flags=ZipArchive::FL_OVERWRITE, чтобы увидеть влияние значений по умолчанию. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

Интеграция ZipArchive::addFile в проект

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

Диагностика ZipArchive::addFile

Сначала запишите точную сигнатуру public bool ZipArchive::addFile(string $filepath, string $entryname = "", int $start = 0, int $length = ZipArchive::LENGTH_TO_END, int $flags = ZipArchive::FL_OVERWRITE) и фактические типы переданных значений. Затем проверьте состояние экземпляра ZipArchive непосредственно перед методом ZipArchive::addFile. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать ZipArchive::addFile

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

Сравнение ZipArchive::addFile с соседними API

Для ZipArchive::addFile базовый ориентир: добавляет в zip-архив файл по заданному пути; обязательные $filepath; необязательные $entryname, $start, $length, $flags; результат bool. Сопоставление с опубликованными соседями: ZipArchive::replaceFile: заменяет файл в zip-архиве файлом по заданному пути; вход — обязательные $filepath, $index; необязательные $start, $length, $flags; результат — bool. ZipArchive::addFromString: добавляет содержимое в zip-архив как файл; вход — обязательные $name, $content; необязательные $flags; результат — bool. ZipArchive::addEmptyDir: добавляет новую директорию; вход — обязательные $dirname; необязательные $flags; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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