Joomla! API

FtpClient object constructor

__construct(array options = []) : mixed

since	1.0

Arguments

options: arrayAssociative array of options to set

Response

mixed

FtpClient object destructor

__destruct() : mixed

Closes an existing connection, if we have one

since	1.0

Response

mixed

Method to find out the correct transfer mode for a specific file

_findMode(string fileName) : int

since	1.0

Arguments

fileName: stringName of the file

Response

intTransfer-mode for this filetype [FTP_ASCII|FTP_BINARY]

Set transfer mode

_mode(int mode) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

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

Set server to passive mode and open a data port connection

_passive() : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

boolTrue if successful

Send command to the FTP server and validate an expected response code

_putCmd(string cmd, mixed expectedResponse) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

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

Verify the response code from the server and log response if flag is set

_verifyResponse(mixed expected) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

expected: mixedInteger response code or array of integer response codes

Response

boolTrue if response code from the server is expected

Method to change the current working directory on the FTP server

chdir(string path) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringPath to change into on the server

Response

boolTrue if successful

Method to change mode for a path on the FTP server

chmod(string path, mixed mode) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

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

Method to connect to a FTP server

connect(string host = '127.0.0.1', int port = 21) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

host: stringHost to connect to [Default: 127.0.0.1]
port: intPort to connect on [Default: port 21]

Response

boolTrue if successful

Method to create an empty file on the FTP server

create(string path) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringPath local file to store on the FTP server

Response

boolTrue if successful

Method to delete a path [file/folder] on the FTP server

delete(string path) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringPath to delete

Response

boolTrue if successful

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	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

local: stringLocal path to save remote file to
remote: stringPath to remote file to get on the FTP server

Response

boolTrue if successful

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

static

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: arrayArray 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

\Joomla\Filesystem\Clients\FtpClientThe FTP Client object.

Method to determine if the object is connected to an FTP server

isConnected() : bool

since	1.0

Response

boolTrue if connected

Method to list the contents of a directory on the FTP server

listDetails(string path = null, string type = 'all') : string[]

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringPath to the local file to be stored on the FTP server
type: stringReturn type [raw|all|folders|files]

Response

string[]If $type is raw: string Directory listing, otherwise array of string with file-names

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	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringPath local file to store on the FTP server

Response

stringDirectory listing

Method to login to a server once connected

login(string user = 'anonymous', string pass = '[email protected]') : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

user: stringUsername to login to the server
pass: stringPassword to login to the server

Response

boolTrue if successful

Method to create a directory on the FTP server

mkdir(string path) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

path: stringDirectory to create

Response

boolTrue if successful

Method to retrieve the current working directory on the FTP server

pwd() : string

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

stringCurrent working directory

Method to quit and close the connection

quit() : bool

since	1.0

Response

boolTrue if successful

Method to read a file from the FTP server's contents into a buffer

read(string remote, string &buffer) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

remote: stringPath to remote file to read on the FTP server
buffer: stringBuffer variable to read file contents into

Response

boolTrue if successful

Method to reinitialise the server, ie. need to login again

reinit() : bool

NOTE: This command not available on all servers

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

boolTrue if successful

Method to rename a file/folder on the FTP server

rename(string from, string to) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

from: stringPath to change file/folder from
to: stringPath to change file/folder to

Response

boolTrue if successful

Method to restart data transfer at a given byte

restart(int point) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

point: intByte to restart transfer at

Response

boolTrue if successful

Set client options

setOptions(array options) : bool

since	1.0

Arguments

options: arrayAssociative array of options to set

Response

boolTrue if successful

Method to store a file to the FTP server

store(string local, string remote = null) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

local: stringPath to local file to store on the FTP server
remote: stringFTP path to file to create

Response

boolTrue if successful

Method to system string from the FTP server

syst() : string

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

stringSystem identifier string

Method to write a string to the FTP server

write(string remote, string buffer) : bool

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

remote: stringFTP path to file to write to
buffer: stringContents to write to the FTP server

Response

boolTrue if successful

Socket resource

since	1.0

Type(s)

resource

Data port connection resource

since	1.0

Type(s)

resource

Passive connection information

since	1.0

Type(s)

array

Response Message

since	1.0

Type(s)

string

Response Code

since	1.0

Type(s)

int

Response Message

since	1.0

Type(s)

string

Timeout limit

since	1.0

Type(s)

int

Transfer Type

since	1.0

Type(s)

int

Array to hold ascii format file extensions

since	1.0

Type(s)

array

Array to hold native line ending characters

since	1.0

Type(s)

array

FtpClient instances container.

static

since	1.0

Type(s)

\Joomla\Filesystem\Clients\FtpClient[]

since	1.0
package	Joomla Framework

FtpClient

Methods

__construct

Arguments

Response

__destruct

Response

_findMode

Arguments

Response

_mode

Arguments

Response

_passive

Response

_putCmd

Arguments

Response

_verifyResponse

Arguments

Response

chdir

Arguments

Response

chmod

Arguments

Response

connect

Arguments

Response

create

Arguments

Response

delete

Arguments

Response

get

Arguments

Response

getInstance

Arguments

Response

isConnected

Response

listDetails

Arguments

Response

listNames

Arguments

Response

login

Arguments

Response

mkdir

Arguments

Response

pwd

Response

quit

Response

read

Arguments

Response

reinit

Response

rename

Arguments

Response

restart

Arguments

Response

setOptions

Arguments

Response

store

Arguments

Response

syst

Response

write