Ftp uses ConstantsTrait
Enumerates the configuration keys understood by the {@see \oihana\ftp\FtpClient}.
The values double as the property names of FtpOptions,
so a configuration array and an FtpOptions instance are interchangeable.
Tags
Table of Contents
Constants
- HOST : string = 'host'
- The remote host name or IP address.
- MAX_RETRIES : string = 'maxRetries'
- The maximum number of attempts for a transient connection failure. Defaults to 3.
- PASSIVE : string = 'passive'
- Whether to use passive mode (recommended behind NAT/firewalls). Defaults to true.
- PASSWORD : string = 'password'
- The login password.
- PORT : string = 'port'
- The remote control-channel port. Defaults to 21.
- ROOT : string = 'root'
- An optional remote base directory the client changes into right after login.
- SECURITY : string = 'security'
- The transport security mode, one of the {@see FtpSecurity} constants.
- TIMEOUT : string = 'timeout'
- The connection timeout, in seconds. Defaults to 90.
- TRANSFER_MODE : string = 'transferMode'
- The default transfer mode, one of the {@see FtpTransferMode} constants.
- USERNAME : string = 'username'
- The login user name. Use `anonymous` for anonymous access.
Constants
HOST
The remote host name or IP address.
public
string
HOST
= 'host'
MAX_RETRIES
The maximum number of attempts for a transient connection failure. Defaults to 3.
public
string
MAX_RETRIES
= 'maxRetries'
PASSIVE
Whether to use passive mode (recommended behind NAT/firewalls). Defaults to true.
public
string
PASSIVE
= 'passive'
PASSWORD
The login password.
public
string
PASSWORD
= 'password'
PORT
The remote control-channel port. Defaults to 21.
public
string
PORT
= 'port'
ROOT
An optional remote base directory the client changes into right after login.
public
string
ROOT
= 'root'
SECURITY
The transport security mode, one of the {@see FtpSecurity} constants.
public
string
SECURITY
= 'security'
TIMEOUT
The connection timeout, in seconds. Defaults to 90.
public
string
TIMEOUT
= 'timeout'
TRANSFER_MODE
The default transfer mode, one of the {@see FtpTransferMode} constants.
public
string
TRANSFER_MODE
= 'transferMode'
USERNAME
The login user name. Use `anonymous` for anonymous access.
public
string
USERNAME
= 'username'