Phar::buildFromDirectory — Создаёт phar-архив из файлов, расположенных внутри директории

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

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

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

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

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

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

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

Структурная запись: public array Phar::buildFromDirectory(string $directory, string $pattern = ""). В ней 2 параметра: обязательные $directory; необязательные $pattern. Результат объявлен как array; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

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

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

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

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

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

Phar::buildFromDirectory объявляет результат типа array. Phar::buildFromDirectory возвращает коллекцию типа array. Пустой набор может быть корректным результатом, поэтому его смысл определяют отдельно от исключения или диагностического сообщения.

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

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

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

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

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

Сначала запишите точную сигнатуру public array Phar::buildFromDirectory(string $directory, string $pattern = "") и фактические типы переданных значений. Затем проверьте состояние экземпляра Phar непосредственно перед методом Phar::buildFromDirectory. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для Phar::buildFromDirectory базовый ориентир: создаёт phar-архив из файлов, расположенных внутри директории; обязательные $directory; необязательные $pattern; результат array. Совпадение имени buildFromDirectory не делает методы взаимозаменяемыми: Phar::buildFromDirectory принадлежит Phar, а PharData::buildFromDirectory — PharData. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: PharData::buildFromDirectory: создаёт tar/zip-архив из файлов в директории; вход — обязательные $directory; необязательные $pattern; результат — array. Phar::buildFromIterator: создаёт phar-архив из итератора; вход — обязательные $iterator; необязательные $baseDirectory; результат — array. PharData::buildFromIterator: создание tar/zip-архива с помощью итератора; вход — обязательные $iterator; необязательные $baseDirectory; результат — array. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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