ssh2_sftp_realpath — Возвращает канонизированный абсолютный путь

Назначение ssh2_sftp_realpath

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

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

Это процедурная функция раздела «ssh2». Её отличают имя ssh2_sftp_realpath, контракт «обязательные $sftp, $filename» и объявленный результат string|false; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура ssh2_sftp_realpath

Структурная запись: string|false ssh2_sftp_realpath(resource $sftp, string $filename). В ней 2 параметра: обязательные $sftp, $filename. Результат объявлен как string|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ssh2_sftp_realpath

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

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

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

Результат ssh2_sftp_realpath

ssh2_sftp_realpath объявляет результат типа string|false. Контракт ssh2_sftp_realpath допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

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

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

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

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

Сначала запишите точную сигнатуру string|false ssh2_sftp_realpath(resource $sftp, string $filename) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ssh2» в той же среде, где выполняется ssh2_sftp_realpath. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для ssh2_sftp_realpath предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для ssh2_sftp_realpath базовый ориентир: возвращает канонизированный абсолютный путь; обязательные $sftp, $filename; результат string|false. Сопоставление с опубликованными соседями: realpath: возвращает канонизированный абсолютный путь к файлу; вход — обязательные $path; результат — string|false. ssh2_sftp_readlink: возвращает целевой путь символической ссылки; вход — обязательные $sftp, $link; результат — string|false. ssh2_sftp: инициализировать подсистему sftp; вход — обязательные $session; результат — resource|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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