Работа с sftp средствами api Bitrix

28 май 2022

Дмитрий М.

982

В api Bitrix присутствую методы которые позволяют работать с ресурсами по протоколу sftp.

Данные методы находятся в модуле sale.

Вот список этих методов:

Bitrix\Sale\TradingPlatform\Sftp::__construct()	Конструктор класса работы с Sftp, в нём задаются параметры соединения
Bitrix\Sale\TradingPlatform\Sftp::connect()	Метод, которые инициирует соединение с хостом с заданными параметрами
Bitrix\Sale\TradingPlatform\Sftp::downloadFile()	Метод, позволяет скачивать удалённые файлы
Bitrix\Sale\TradingPlatform\Sftp::getFileSize()	Метод, позволяет получить размер удалённого файла
Bitrix\Sale\TradingPlatform\Sftp::getFilesList()	Метод, позволяет получить список файлов удалённой папки
Bitrix\Sale\TradingPlatform\Sftp::uploadFile()	Метод, позволяет загрузить файл в удалённую папку по sftp

Метод Bitrix\Sale\TradingPlatform\Sftp::__construct()

Пример кода запроса:

Копировать код

\Bitrix\Main\Loader::includeModule('sale');
$connect = new \Bitrix\Sale\TradingPlatform\Sftp(
    $USERNAME,
    $PASSWORD,
    $HOST,
    $PORT
);

В параметрах указываются:

$USERNAME	sftp имя пользователя
$PASSWORD	sftp пароль пользователя
$HOST	sftp хост подключение
$PORT	порт sftp подключения

Метод Bitrix\Sale\TradingPlatform\Sftp::connect()

Данный метод инициализирует соединение по указанным параметрам

Копировать код

\Bitrix\Main\Loader::includeModule('sale');
$connect = new \Bitrix\Sale\TradingPlatform\Sftp(
    $USERNAME,
    $PASSWORD,
    $HOST,
    $PORT
);
$connect->connect(); // Инициализирует соединение по указанным параметрам

Метод Bitrix\Sale\TradingPlatform\Sftp::downloadFile()

Метод позволяет скачать удалённый файл. Метод принимает два параметра $remoteFile, $localFile.

В параметре $remoteFile указывается файл с путём на удалённом хранилище.

В параметре $localFile файл с путём куда требуется сохранить файл.

Копировать код

\Bitrix\Main\Loader::includeModule('sale');
$connect = new \Bitrix\Sale\TradingPlatform\Sftp(
    $USERNAME,
    $PASSWORD,
    $HOST,
    $PORT
);
$connect->connect(); // Инициализирует соединение по указанным параметрам
$connect->downloadFile($remoteFile, $localFile);

Метод Bitrix\Sale\TradingPlatform\Sftp::getFileSize()

Метод позволяет получить размер удалённого файла $pathToFile:

Копировать код

\Bitrix\Main\Loader::includeModule('sale');
$connect = new \Bitrix\Sale\TradingPlatform\Sftp(
    $USERNAME,
    $PASSWORD,
    $HOST,
    $PORT
);
$connect->connect(); // Инициализирует соединение по указанным параметрам
$fileSize = $connect->getFileSize($pathToFile);