ssh2_exec — Выполнение команды на удалённом сервере

Назначение ssh2_exec

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

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

Это процедурная функция раздела «ssh2». Её отличают имя ssh2_exec, контракт «обязательные $session, $command; необязательные $pty, $env, $width, $height, $width_height_type» и объявленный результат resource|false; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура ssh2_exec

Структурная запись: resource|false ssh2_exec(resource $session, string $command, string $pty = значение по умолчанию, array $env = значение по умолчанию, int $width = 80, int $height = 25, int $width_height_type = SSH2_TERM_UNIT_CHARS). В ней 7 параметров: обязательные $session, $command; необязательные $pty, $env, $width, $height, $width_height_type. Результат объявлен как resource|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ssh2_exec

Порядок и роли аргументов по сигнатуре: 1. $session — resource, обязателен; 2. $command — string, обязателен; 3. $pty — string, необязателен; 4. $env — array, необязателен; 5. $width — int, необязателен, default 80; 6. $height — int, необязателен, default 25; 7. $width_height_type — int, необязателен, default SSH2_TERM_UNIT_CHARS.

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

1) resource $session — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string $command — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $pty — необязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 4) array $env — необязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 5) int $width — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 6) int $height — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 7) int $width_height_type — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки.

Результат ssh2_exec

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

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

Убедитесь, что раздел «ssh2» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором resource $session, string $command. Затем отдельно добавьте необязательные параметры string $pty, array $env, int $width=80, int $height=25, int $width_height_type=SSH2_TERM_UNIT_CHARS, чтобы увидеть влияние значений по умолчанию. Для профиля «сетевое взаимодействие» важно задавать таймауты и не считать транспортный успех бизнес-успехом; негативный сценарий должен проверить таймаут, недоступный узел и некорректный ответ.

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

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

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

Сначала запишите точную сигнатуру resource|false ssh2_exec(resource $session, string $command, string $pty = значение по умолчанию, array $env = значение по умолчанию, int $width = 80, int $height = 25, int $width_height_type = SSH2_TERM_UNIT_CHARS) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ssh2» в той же среде, где выполняется ssh2_exec. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для ssh2_exec предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для ssh2_exec базовый ориентир: выполнение команды на удалённом сервере; обязательные $session, $command; необязательные $pty, $env, $width, $height, $width_height_type; результат resource|false. Сопоставление с опубликованными соседями: ssh2_connect: подключается к серверу по протоколу ssh; вход — обязательные $host; необязательные $port, $methods, $callbacks; результат — resource|false. ssh2_shell: запрашивает интерактивный терминал; вход — обязательные $session; необязательные $termtype, $env, $width, $height, $width_height_type; результат — resource|false. ssh2_tunnel: открыть туннель через удалённый сервер; вход — обязательные $session, $host, $port; результат — resource. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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