Skip to content

omnidrive/ftp API reference

Floor
Provider · Omnidrive
Version
1.x
Conformance suite
runs, CI green
Verified for real
Verified in part
Licence
MIT
composer require omnidrive/ftp:1.x-dev

Read from the package's own PHP files at the commit 13842d913214: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.

Omnidrive\Ftp

  • FtpDriveFactory class

    A directory of an FTP or FTPS server, through league/flysystem-ftp (PHP's ftp extension):

    12 options

Omnidrive\Ftp

FtpDriveFactory class

final class FtpDriveFactory extends FlysystemDriveFactory FtpDriveFactory.php:28

A directory of an FTP or FTPS server, through league/flysystem-ftp (PHP's ftp extension):

(new FtpDriveFactory())->create(['host' => 'ftp.example.org', 'username' => 'site', 'password' => '...', 'root' => '/www/uploads', 'ssl' => true]);

Options: host, username and password (required), port (21), root (the directory behind the drive's paths, "/"), ssl (FTPS, explicit), passive (true), ignore_passive_address (the address a server behind NAT gives for passive mode ignored, its own used), timeout (90 s), utf8, binary (true: transfers in binary mode, else ASCII), system_type ("unix", "windows": else asked), recurse_manually (a deep listing walked directory by directory, true), timestamps_on_unix_listings, public_url, visibility, directory_visibility, permissions (as every drive).

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

Options

OptionDefault
port21
root'/'
sslfalse
passivetrue
timeout90
utf8false
binarytrue
recurse_manuallytrue
timestamps_on_unix_listingsfalse
hostrequired
usernamerequired
passwordrequired