FtpOptions extends Options
A typed, fluent configuration object for the {@see \oihana\ftp\FtpClient}.
Its property names match the Ftp configuration keys, so an
FtpOptions instance and a plain configuration array are interchangeable when
constructing the client.
Tags
Table of Contents
Properties
- $host : string|null
- The remote host name or IP address.
- $maxRetries : int
- The maximum number of attempts for a transient connection failure.
- $passive : bool
- Whether to use passive mode.
- $password : string|null
- The login password.
- $port : int
- The control-channel port.
- $root : string|null
- An optional remote base directory to change into right after login.
- $security : string
- The transport security mode, one of the {@see FtpSecurity} constants.
- $timeout : int
- The connection timeout, in seconds.
- $username : string|null
- The login user name.
Methods
- __toString() : string
- Returns the string expression of the object (the remote host).
Properties
$host
The remote host name or IP address.
public
string|null
$host
= null
$maxRetries
The maximum number of attempts for a transient connection failure.
public
int
$maxRetries
= 3
$passive
Whether to use passive mode.
public
bool
$passive
= true
$password
The login password.
public
string|null
$password
= null
$port
The control-channel port.
public
int
$port
= 21
$root
An optional remote base directory to change into right after login.
public
string|null
$root
= null
$security
The transport security mode, one of the {@see FtpSecurity} constants.
public
string
$security
= \oihana\ftp\enums\FtpSecurity::NONE
$timeout
The connection timeout, in seconds.
public
int
$timeout
= 90
$username
The login user name.
public
string|null
$username
= null
Methods
__toString()
Returns the string expression of the object (the remote host).
public
__toString() : string