rename — Переименовывает файл или директорию

Назначение rename

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

Чем отличается rename

Это процедурная функция раздела «Файловая система». Её отличают имя rename, контракт «обязательные $from, $to; необязательные $context» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление rename

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

Сигнатура rename

Структурная запись: bool rename(string $from, string $to, resource|null $context = null). В ней 3 параметра: обязательные $from, $to; необязательные $context. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры rename

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

Контроль входных данных для rename

1) string $from — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) string $to — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) resource|null $context — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию.

Результат rename

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

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

Убедитесь, что раздел «Файловая система» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $from, string $to. Затем отдельно добавьте необязательные параметры resource|null $context=null, чтобы увидеть влияние значений по умолчанию. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

Интеграция rename в проект

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

Диагностика rename

Сначала запишите точную сигнатуру bool rename(string $from, string $to, resource|null $context = null) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Файловая система» в той же среде, где выполняется rename. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать rename

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

Сравнение rename с соседними API

Для rename базовый ориентир: переименовывает файл или директорию; обязательные $from, $to; необязательные $context; результат bool. Сопоставление с опубликованными соседями: move_uploaded_file: перемещает загруженный файл в новое место; вход — обязательные $from, $to; результат — bool. mkdir: создаёт директорию; вход — обязательные $directory; необязательные $permissions, $recursive, $context; результат — bool. fflush: сбрасывает буфер вывода в файл; вход — обязательные $stream; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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