ftp_rename — Переименовывает файл или директорию на FTP-сервере

Назначение ftp_rename

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

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

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

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

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

Сигнатура ftp_rename

Структурная запись: bool ftp_rename(FTP\Connection $ftp, string $from, string $to). В ней 3 параметра: обязательные $ftp, $from, $to. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ftp_rename

Порядок и роли аргументов по сигнатуре: 1. $ftp — FTP\Connection, обязателен; 2. $from — string, обязателен; 3. $to — string, обязателен.

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

1) FTP\Connection $ftp — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string $from — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $to — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат ftp_rename

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

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

Убедитесь, что раздел «ftp» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором FTP\Connection $ftp, string $from, string $to. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

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

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

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

Сначала запишите точную сигнатуру bool ftp_rename(FTP\Connection $ftp, string $from, string $to) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ftp» в той же среде, где выполняется ftp_rename. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для ftp_rename базовый ориентир: переименовывает файл или директорию на ftp-сервере; обязательные $ftp, $from, $to; результат bool. Сопоставление с опубликованными соседями: ftp_chdir: изменяет текущую директорию на ftp-сервере; вход — обязательные $ftp, $directory; результат — bool. ftp_cdup: переходит в родительскую директорию; вход — обязательные $ftp; результат — bool. ftp_exec: запрашивает выполнение команды на ftp-сервере; вход — обязательные $ftp, $command; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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