FtpClient
FTP client class
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
FtpClient object constructor
__construct(mixed||string|int options = []) :
| since |
1.0 |
|---|
Arguments
- options
array<string|int, mixed>Associative array of options to set
Response
mixed
__destruct
FtpClient object destructor
__destruct() :
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( fileName) :
| since |
1.0 |
|---|
Arguments
- fileName
stringName of the file
Response
intTransfer-mode for this filetype [FTP_ASCII|FTP_BINARY]
_mode
Set transfer mode
_mode( mode) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- mode
intInteger representation of data transfer mode [1:Binary|0:Ascii] Defined constants can also be used [FTP_BINARY|FTP_ASCII]
Response
boolTrue if successful
_passive
Set server to passive mode and open a data port connection
_passive() :
_putCmd
Send command to the FTP server and validate an expected response code
_putCmd( cmd, expectedResponse) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- cmd
stringCommand to send to the FTP server- expectedResponse
mixedInteger response code or array of integer response codes
Response
boolTrue if command executed successfully
_verifyResponse
Verify the response code from the server and log response if flag is set
_verifyResponse( expected) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- expected
mixedInteger response code or array of integer response codes
Response
boolTrue if response code from the server is expected
chdir
Method to change the current working directory on the FTP server
chdir( path) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringPath to change into on the server
Response
boolTrue if successful
chmod
Method to change mode for a path on the FTP server
chmod( path, mode) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringPath to change mode on- mode
mixedOctal value to change mode to, e.g. '0777', 0777 or 511 (string or integer)
Response
boolTrue if successful
connect
Method to connect to a FTP server
connect( host = '127.0.0.1', port = 21) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- host
stringHost to connect to [Default: 127.0.0.1]- port
intPort to connect on [Default: port 21]
Response
boolTrue if successful
create
Method to create an empty file on the FTP server
create( path) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringPath local file to store on the FTP server
Response
boolTrue if successful
delete
Method to delete a path [file/folder] on the FTP server
delete( path) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringPath to delete
Response
boolTrue if successful
get
Method to get a file from the FTP server and save it to a local file
get( local, remote) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- local
stringLocal path to save remote file to- remote
stringPath to remote file to get on the FTP server
Response
boolTrue if successful
getInstance
Returns the global FTP connector object, only creating it if it doesn't already exist.
getInstance( host = '127.0.0.1', port = '21', mixed||string|int options = [], user = null, 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
stringHost to connect to- port
stringPort to connect to- options
array<string|int, mixed>Array with any of these options: type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY], timeout=>(int)- user
stringUsername to use for a connection- pass
stringPassword to use for a connection
Response
FtpClientThe FTP Client object.
isConnected
Method to determine if the object is connected to an FTP server
isConnected() :
| since |
1.0 |
|---|
Response
boolTrue if connected
listDetails
Method to list the contents of a directory on the FTP server
listDetails( path = null, type = 'all') : string||string|int
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringPath to the local file to be stored on the FTP server- type
stringReturn type [raw|all|folders|files]
Response
array<string|int, 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( path = null) :
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
stringPath local file to store on the FTP server
Response
stringDirectory listing
login
Method to login to a server once connected
login( user = 'anonymous', pass = '[email protected]') :
| since |
1.0 |
|---|---|
| throws |
Arguments
- user
stringUsername to login to the server- pass
stringPassword to login to the server
Response
boolTrue if successful
mkdir
Method to create a directory on the FTP server
mkdir( path) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- path
stringDirectory to create
Response
boolTrue if successful
pwd
Method to retrieve the current working directory on the FTP server
pwd() :
quit
Method to quit and close the connection
quit() :
| since |
1.0 |
|---|
Response
boolTrue if successful
read
Method to read a file from the FTP server's contents into a buffer
read( remote, &buffer) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- remote
stringPath to remote file to read on the FTP server- buffer
stringBuffer variable to read file contents into
Response
boolTrue if successful
reinit
Method to reinitialise the server, ie. need to login again
reinit() :
NOTE: This command not available on all servers
| since |
1.0 |
|---|---|
| throws |
Response
boolTrue if successful
rename
Method to rename a file/folder on the FTP server
rename( from, to) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- from
stringPath to change file/folder from- to
stringPath to change file/folder to
Response
boolTrue if successful
restart
Method to restart data transfer at a given byte
restart( point) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- point
intByte to restart transfer at
Response
boolTrue if successful
setOptions
Set client options
setOptions(mixed||string|int options) :
| since |
1.0 |
|---|
Arguments
- options
array<string|int, mixed>Associative array of options to set
Response
boolTrue if successful
store
Method to store a file to the FTP server
store( local, remote = null) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- local
stringPath to local file to store on the FTP server- remote
stringFTP path to file to create
Response
boolTrue if successful
syst
Method to system string from the FTP server
syst() :
write
Method to write a string to the FTP server
write( remote, buffer) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- remote
stringFTP path to file to write to- buffer
stringContents to write to the FTP server
Response
boolTrue if successful
Properties
conn
Socket resource
| since |
1.0 |
|---|
Type(s)
Connection
dataconn
Data port connection resource
| since |
1.0 |
|---|
Type(s)
resource
pasv
Passive connection information
| since |
1.0 |
|---|
Type(s)
array<string|int, mixed>
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<string|int, mixed>
lineEndings
Array to hold native line ending characters
| since |
1.0 |
|---|
Type(s)
array<string|int, mixed>