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

Назначение streamWrapper::rename

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

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

Эта страница описывает член rename класса streamWrapper, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $path_from, $path_to; объявленный результат — bool.

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

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

Сигнатура streamWrapper::rename

Структурная запись: public bool streamWrapper::rename(string $path_from, string $path_to). В ней 2 параметра: обязательные $path_from, $path_to. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры streamWrapper::rename

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

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

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

Результат streamWrapper::rename

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

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

Подготовьте объект streamWrapper в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором string $path_from, string $path_to. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «файловый ввод-вывод» важно нормализовать путь и ограничить доступ разрешённой областью; негативный сценарий должен проверить отсутствие файла, права, пустой поток и частичное чтение.

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

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

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

Сначала запишите точную сигнатуру public bool streamWrapper::rename(string $path_from, string $path_to) и фактические типы переданных значений. Затем проверьте состояние экземпляра streamWrapper непосредственно перед методом streamWrapper::rename. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для streamWrapper::rename базовый ориентир: переименовывает файл или директорию; обязательные $path_from, $path_to; результат bool. Сопоставление с опубликованными соседями: rename: переименовывает файл или директорию; вход — обязательные $from, $to; необязательные $context; результат — bool. streamWrapper::rmdir: удаляет директорию; вход — обязательные $path, $options; результат — bool. streamWrapper::stream_open: открывает файл или url; вход — обязательные $path, $mode, $options, $opened_path; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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