ZipArchive::addPattern — Добавить файлы из директории в соответствии с шаблоном регулярного выражения PCRE

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

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

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

Эта страница описывает член addPattern класса ZipArchive, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $pattern; необязательные $path, $options; объявленный результат — array|false.

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

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

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

Структурная запись: public array|false ZipArchive::addPattern(string $pattern, string $path = ".", array $options = []). В ней 3 параметра: обязательные $pattern; необязательные $path, $options. Результат объявлен как array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

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

Порядок и роли аргументов по сигнатуре: 1. $pattern — string, обязателен; 2. $path — string, необязателен, default "."; 3. $options — array, необязателен, default [].

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

1) string $pattern — обязательный: испытайте корректный, пустой и синтаксически ошибочный шаблон или формат. 2) string $path — необязательный: нормализуйте представление, проверьте допустимую схему или базовый каталог и отдельно испытайте отсутствующую цель. 3) array $options — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию.

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

ZipArchive::addPattern объявляет результат типа array|false. Контракт ZipArchive::addPattern допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

Подготовьте объект ZipArchive в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором string $pattern. Затем отдельно добавьте необязательные параметры string $path=".", array $options=[], чтобы увидеть влияние значений по умолчанию. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

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

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

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

Сначала запишите точную сигнатуру public array|false ZipArchive::addPattern(string $pattern, string $path = ".", array $options = []) и фактические типы переданных значений. Затем проверьте состояние экземпляра ZipArchive непосредственно перед методом ZipArchive::addPattern. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для ZipArchive::addPattern предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для ZipArchive::addPattern базовый ориентир: добавить файлы из директории в соответствии с шаблоном регулярного выражения pcre; обязательные $pattern; необязательные $path, $options; результат array|false. Сопоставление с опубликованными соседями: ZipArchive::addFile: добавляет в zip-архив файл по заданному пути; вход — обязательные $filepath; необязательные $entryname, $start, $length, $flags; результат — bool. ZipArchive::addGlob: добавляет файлы из директории по glob-шаблону; вход — обязательные $pattern; необязательные $flags, $options; результат — array|false. ZipArchive::statIndex: получение детальной информации о элементе по его индексу; вход — обязательные $index; необязательные $flags; результат — array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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