Aller au contenu

omnidrive/sftp Référence de l’API

Étage
Fournisseur · Omnidrive
Version
1.x
Suite de conformité
branchée, CI verte
Vérifié en réel
Vérifié en partie
Licence
MIT
composer require omnidrive/sftp:1.x-dev

Lue dans les fichiers PHP du paquet au commit 206fff7d82de : ses espaces de noms, classes, interfaces et énumérations, leurs constantes, propriétés et méthodes publiques avec leur PHPDoc, et les options que prennent ses fabriques. Rien n’en est exécuté.

Omnidrive\Sftp

  • SftpDriveFactory class

    A directory of an SFTP server, over SSH, through league/flysystem-sftp-v3 (phpseclib 3, pure PHP: no ssh2 extension):

    7 options

Omnidrive\Sftp

SftpDriveFactory class

final class SftpDriveFactory extends FlysystemDriveFactory SftpDriveFactory.php:26

A directory of an SFTP server, over SSH, through league/flysystem-sftp-v3 (phpseclib 3, pure PHP: no ssh2 extension):

(new SftpDriveFactory())->create(['host' => 'backup.example.org', 'username' => 'site', 'private_key' => '/run/secrets/id_ed25519', 'root' => '/srv/backup']);

Options: host and username (required), password, private_key (a path or the key itself) and its passphrase, use_agent (the SSH agent's keys), port (22), root (the directory behind the drive's paths, "/"), host_fingerprint (the server's key checked, "SHA256:..." or the MD5 form phpseclib gives), timeout (10 s), max_tries (4), public_url, visibility, directory_visibility, permissions (as every drive).

The connection is opened on the first operation, not here.

Options

OptionDefault
port22
root'/'
use_agentfalse
timeout10
max_tries4
hostrequired
usernamerequired