SftpClient
in package
Прикладной SFTP-клиент поверх нативной SSH-сессии (без Composer runtime-зависимостей).
Tags
Table of Contents
Methods
- __construct() : mixed
- Создаёт клиент над уже готовым SFTP-каналом.
- delete() : void
- Удаляет файл (не каталог) по пути.
- exists() : bool
- Проверяет существование пути через SSH_FXP_STAT.
- get() : string
- Читает удалённый файл целиком через OPEN + READ до EOF.
- list() : array<int, string>
- Возвращает имена записей каталога (без «.» / «..» фильтрации — как отдал сервер).
- mkdir() : void
- Создаёт каталог с правами 0777 (маска сервера может сузить).
- put() : void
- Записывает (создаёт/перезаписывает) удалённый файл через OPEN + WRITE.
- resource() : SftpChannelInterface
- Возвращает низкоуровневый SFTP-канал для расширенных сценариев.
Methods
__construct()
Создаёт клиент над уже готовым SFTP-каналом.
public
__construct(SftpChannelInterface $session) : mixed
Parameters
- $session : SftpChannelInterface
-
Канал sendSftp/receiveSftp
delete()
Удаляет файл (не каталог) по пути.
public
delete(string $remotePath) : void
Parameters
- $remotePath : string
-
Путь к файлу
Tags
exists()
Проверяет существование пути через SSH_FXP_STAT.
public
exists(string $remotePath) : bool
Parameters
- $remotePath : string
-
Путь к файлу или каталогу
Return values
bool —true при SSH_FXP_ATTRS; false при ошибке/отсутствии
get()
Читает удалённый файл целиком через OPEN + READ до EOF.
public
get(string $remotePath) : string
Parameters
- $remotePath : string
-
Абсолютный или относительный путь на сервере
Tags
Return values
string —Содержимое файла (может быть пустым)
list()
Возвращает имена записей каталога (без «.» / «..» фильтрации — как отдал сервер).
public
list([string $remotePath = '.' ]) : array<int, string>
Parameters
- $remotePath : string = '.'
-
Путь к каталогу; по умолчанию текущий «.»
Tags
Return values
array<int, string> —Имена файлов и подкаталогов; [] если каталог пуст
mkdir()
Создаёт каталог с правами 0777 (маска сервера может сузить).
public
mkdir(string $remotePath) : void
Parameters
- $remotePath : string
-
Путь нового каталога
Tags
put()
Записывает (создаёт/перезаписывает) удалённый файл через OPEN + WRITE.
public
put(string $remotePath, string $contents) : void
Parameters
- $remotePath : string
-
Абсолютный или относительный путь на сервере
- $contents : string
-
Байты для записи (в т.ч. бинарные)
Tags
resource()
Возвращает низкоуровневый SFTP-канал для расширенных сценариев.
public
resource() : SftpChannelInterface
Return values
SftpChannelInterface —Тот же канал, что передан в конструктор