Phar::addFile — Добавляет в phar-архив файл из файловой системы

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

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

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

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

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

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

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

Структурная запись: public void Phar::addFile(string $filename, string|null $localName = null). В ней 2 параметра: обязательные $filename; необязательные $localName. Результат объявлен как void; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

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

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

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

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

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

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

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

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

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

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

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

Сначала запишите точную сигнатуру public void Phar::addFile(string $filename, string|null $localName = null) и фактические типы переданных значений. Затем проверьте состояние экземпляра Phar непосредственно перед методом Phar::addFile. Если результат неожиданен, сравните его тип с void и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для Phar::addFile базовый ориентир: добавляет в phar-архив файл из файловой системы; обязательные $filename; необязательные $localName; результат void. Совпадение имени addFile не делает методы взаимозаменяемыми: Phar::addFile принадлежит Phar, а PharData::addFile — PharData. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: PharData::addFile: добавить существующие файлы к tar/zip-архиву; вход — обязательные $filename; необязательные $localName; результат — void. Phar::offsetSet: изменение содержимого файла; вход — обязательные $localName, $value; результат — void. Phar::addFromString: добавляет в phar-архив файл из строки; вход — обязательные $localName, $contents; результат — void. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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