FtpClient
FTP client class
since |
1.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
FtpClient object constructor
__construct(array options = []) : mixed
since |
1.0 |
---|
Arguments
- options
array
Associative array of options to set
Response
mixed
__destruct
FtpClient object destructor
__destruct() : mixed
Closes an existing connection, if we have one
since |
1.0 |
---|
Response
mixed
_findMode
Method to find out the correct transfer mode for a specific file
_findMode(string fileName) : int
since |
1.0 |
---|
Arguments
- fileName
string
Name of the file
Response
int
Transfer-mode for this filetype [FTP_ASCII|FTP_BINARY]
_mode
Set transfer mode
_mode(int mode) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- mode
int
Integer representation of data transfer mode [1:Binary|0:Ascii] Defined constants can also be used [FTP_BINARY|FTP_ASCII]
Response
bool
True if successful
_passive
Set server to passive mode and open a data port connection
_passive() : bool
since |
1.0 |
---|---|
throws |
|
Response
bool
True if successful
_putCmd
Send command to the FTP server and validate an expected response code
_putCmd(string cmd, mixed expectedResponse) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- cmd
string
Command to send to the FTP server- expectedResponse
mixed
Integer response code or array of integer response codes
Response
bool
True if command executed successfully
_verifyResponse
Verify the response code from the server and log response if flag is set
_verifyResponse(mixed expected) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- expected
mixed
Integer response code or array of integer response codes
Response
bool
True if response code from the server is expected
chdir
Method to change the current working directory on the FTP server
chdir(string path) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path to change into on the server
Response
bool
True if successful
chmod
Method to change mode for a path on the FTP server
chmod(string path, mixed mode) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path to change mode on- mode
mixed
Octal value to change mode to, e.g. '0777', 0777 or 511 (string or integer)
Response
bool
True if successful
connect
Method to connect to a FTP server
connect(string host = '127.0.0.1', int port = 21) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- host
string
Host to connect to [Default: 127.0.0.1]- port
int
Port to connect on [Default: port 21]
Response
bool
True if successful
create
Method to create an empty file on the FTP server
create(string path) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path local file to store on the FTP server
Response
bool
True if successful
delete
Method to delete a path [file/folder] on the FTP server
delete(string path) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path to delete
Response
bool
True if successful
get
Method to get a file from the FTP server and save it to a local file
get(string local, string remote) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- local
string
Local path to save remote file to- remote
string
Path to remote file to get on the FTP server
Response
bool
True if successful
getInstance
Returns the global FTP connector object, only creating it if it doesn't already exist.
getInstance(string host = '127.0.0.1', string port = '21', array options = [], string user = null, string pass = null) : \Joomla\Filesystem\Clients\FtpClient
You may optionally specify a username and password in the parameters. If you do so, you may not login() again with different credentials using the same object. If you do not use this option, you must quit() the current connection when you are done, to free it for use by others.
since |
1.0 |
---|
Arguments
- host
string
Host to connect to- port
string
Port to connect to- options
array
Array with any of these options: type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY], timeout=>(int)- user
string
Username to use for a connection- pass
string
Password to use for a connection
Response
\Joomla\Filesystem\Clients\FtpClient
The FTP Client object.
isConnected
Method to determine if the object is connected to an FTP server
isConnected() : bool
since |
1.0 |
---|
Response
bool
True if connected
listDetails
Method to list the contents of a directory on the FTP server
listDetails(string path = null, string type = 'all') : string[]
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path to the local file to be stored on the FTP server- type
string
Return type [raw|all|folders|files]
Response
string[]
If $type is raw: string Directory listing, otherwise array of string with file-names
listNames
Method to list the filenames of the contents of a directory on the FTP server
listNames(string path = null) : string
Note: Some servers also return folder names. However, to be sure to list folders on all servers, you should use listDetails() instead if you also need to deal with folders
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Path local file to store on the FTP server
Response
string
Directory listing
login
Method to login to a server once connected
login(string user = 'anonymous', string pass = '[email protected]') : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
Username to login to the server- pass
string
Password to login to the server
Response
bool
True if successful
mkdir
Method to create a directory on the FTP server
mkdir(string path) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
Directory to create
Response
bool
True if successful
pwd
Method to retrieve the current working directory on the FTP server
pwd() : string
since |
1.0 |
---|---|
throws |
|
Response
string
Current working directory
quit
Method to quit and close the connection
quit() : bool
since |
1.0 |
---|
Response
bool
True if successful
read
Method to read a file from the FTP server's contents into a buffer
read(string remote, string &buffer) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- remote
string
Path to remote file to read on the FTP server- buffer
string
Buffer variable to read file contents into
Response
bool
True if successful
reinit
Method to reinitialise the server, ie. need to login again
reinit() : bool
NOTE: This command not available on all servers
since |
1.0 |
---|---|
throws |
|
Response
bool
True if successful
rename
Method to rename a file/folder on the FTP server
rename(string from, string to) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- from
string
Path to change file/folder from- to
string
Path to change file/folder to
Response
bool
True if successful
restart
Method to restart data transfer at a given byte
restart(int point) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- point
int
Byte to restart transfer at
Response
bool
True if successful
setOptions
Set client options
setOptions(array options) : bool
since |
1.0 |
---|
Arguments
- options
array
Associative array of options to set
Response
bool
True if successful
store
Method to store a file to the FTP server
store(string local, string remote = null) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- local
string
Path to local file to store on the FTP server- remote
string
FTP path to file to create
Response
bool
True if successful
syst
Method to system string from the FTP server
syst() : string
since |
1.0 |
---|---|
throws |
|
Response
string
System identifier string
write
Method to write a string to the FTP server
write(string remote, string buffer) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- remote
string
FTP path to file to write to- buffer
string
Contents to write to the FTP server
Response
bool
True if successful
Properties
conn
Socket resource
since |
1.0 |
---|
Type(s)
resource
dataconn
Data port connection resource
since |
1.0 |
---|
Type(s)
resource
pasv
Passive connection information
since |
1.0 |
---|
Type(s)
array
response
Response Message
since |
1.0 |
---|
Type(s)
string
responseCode
Response Code
since |
1.0 |
---|
Type(s)
int
responseMsg
Response Message
since |
1.0 |
---|
Type(s)
string
timeout
Timeout limit
since |
1.0 |
---|
Type(s)
int
type
Transfer Type
since |
1.0 |
---|
Type(s)
int
autoAscii
Array to hold ascii format file extensions
since |
1.0 |
---|
Type(s)
array
lineEndings
Array to hold native line ending characters
since |
1.0 |
---|
Type(s)
array
instances
FtpClient instances container.
since |
1.0 |
---|
Type(s)
\Joomla\Filesystem\Clients\FtpClient[]