Joomla Platform
13.1
Documentation des API du framework Joomla Platform
|
Fonctions membres publiques | |
__construct (array $options=array()) | |
__destruct () | |
setOptions (array $options) | |
connect ($host= '127.0.0.1', $port=21) | |
isConnected () | |
login ($user= 'anonymous', $pass= 'jftp @joomla.org') | |
quit () | |
pwd () | |
syst () | |
chdir ($path) | |
reinit () | |
rename ($from, $to) | |
chmod ($path, $mode) | |
delete ($path) | |
mkdir ($path) | |
restart ($point) | |
create ($path) | |
read ($remote, &$buffer) | |
get ($local, $remote) | |
store ($local, $remote=null) | |
write ($remote, $buffer) | |
listNames ($path=null) | |
listDetails ($path=null, $type= 'all') |
Fonctions membres publiques statiques | |
static | getInstance ($host= '127.0.0.1', $port= '21', array $options=array(), $user=null, $pass=null) |
Fonctions membres protégées | |
_putCmd ($cmd, $expectedResponse) | |
_verifyResponse ($expected) | |
_passive () | |
_findMode ($fileName) | |
_mode ($mode) |
Attributs protégés statiques | |
static | $instances = array() |
Attributs privés | |
$_conn = null | |
$_dataconn = null | |
$_pasv = null | |
$_response = null | |
$_timeout = 15 | |
$_type = null | |
$_autoAscii | |
$_lineEndings = array('UNIX' => "\n", 'WIN' => "\r\n") |
JClientFtp::__construct | ( | array | $options = array() | ) |
JClientFtp object constructor
array | $options | Associative array of options to set |
Réimplémentée dans JFTP.
Définition à la ligne 139 du fichier ftp.php.
Références jimport(), JLoader\load(), et setOptions().
JClientFtp::__destruct | ( | ) |
JClientFtp object destructor
Closes an existing connection, if we have one
Définition à la ligne 165 du fichier ftp.php.
Références quit().
|
protected |
Method to find out the correct transfer mode for a specific file
string | $fileName | Name of the file |
Définition à la ligne 1705 du fichier ftp.php.
Référencé par get(), read(), store(), et write().
|
protected |
Set transfer mode
integer | $mode | Integer representation of data transfer mode [1:Binary|0:Ascii] Defined constants can also be used [FTP_BINARY|FTP_ASCII] |
Définition à la ligne 1742 du fichier ftp.php.
Références _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
Référencé par get(), read(), store(), et write().
|
protected |
Set server to passive mode and open a data port connection
Définition à la ligne 1617 du fichier ftp.php.
Références $_timeout, JText\_(), JLog\add(), JText\sprintf(), et JLog\WARNING.
Référencé par create(), get(), listDetails(), listNames(), read(), store(), et write().
|
protected |
Send command to the FTP server and validate an expected response code
string | $cmd | Command to send to the FTP server |
mixed | $expectedResponse | Integer response code or array of integer response codes |
Définition à la ligne 1530 du fichier ftp.php.
Références JText\_(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
Référencé par _mode(), chdir(), chmod(), create(), delete(), get(), listDetails(), listNames(), login(), mkdir(), pwd(), read(), reinit(), rename(), restart(), store(), syst(), et write().
|
protected |
Verify the response code from the server and log response if flag is set
mixed | $expected | Integer response code or array of integer response codes |
Définition à la ligne 1558 du fichier ftp.php.
Références $_timeout, JLog\add(), JText\sprintf(), et JLog\WARNING.
Référencé par _putCmd(), connect(), create(), get(), listDetails(), listNames(), read(), store(), et write().
JClientFtp::chdir | ( | $path | ) |
Method to change the current working directory on the FTP server
string | $path | Path to change into on the server |
Définition à la ligne 485 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::chmod | ( | $path, | |
$mode | |||
) |
Method to change mode for a path on the FTP server
string | $path | Path to change mode on |
mixed | $mode | Octal value to change mode to, e.g. '0777', 0777 or 511 (string or integer) |
Définition à la ligne 597 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::connect | ( | $host = '127.0.0.1' , |
|
$port = 21 |
|||
) |
Method to connect to a FTP server
string | $host | Host to connect to [Default: 127.0.0.1] |
string | $port | Port to connect on [Default: port 21] |
Définition à la ligne 252 du fichier ftp.php.
Références _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::create | ( | $path | ) |
Method to create an empty file on the FTP server
string | $path | Path local file to store on the FTP server |
Définition à la ligne 752 du fichier ftp.php.
Références JText\_(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::delete | ( | $path | ) |
Method to delete a path [file/folder] on the FTP server
string | $path | Path to delete |
Définition à la ligne 646 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::get | ( | $local, | |
$remote | |||
) |
Method to get a file from the FTP server and save it to a local file
string | $local | Local path to save remote file to |
string | $remote | Path to remote file to get on the FTP server |
Définition à la ligne 918 du fichier ftp.php.
Références JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
|
static |
Returns the global FTP connector object, only creating it if it doesn't already exist.
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.
string | $host | Host to connect to |
string | $port | Port to connect to |
array | $options | Array with any of these options: type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY], timeout=>(int) |
string | $user | Username to use for a connection |
string | $pass | Password to use for a connection |
Définition à la ligne 192 du fichier ftp.php.
Références isConnected().
Référencé par JFolder\copy(), JFile\copy(), JFolder\create(), JFile\delete(), JFolder\delete(), JFile\move(), JFolder\move(), JClientHelper\setCredentials(), JFile\upload(), et JFile\write().
JClientFtp::isConnected | ( | ) |
Method to determine if the object is connected to an FTP server
Définition à la ligne 311 du fichier ftp.php.
Référencé par getInstance().
JClientFtp::listDetails | ( | $path = null , |
|
$type = 'all' |
|||
) |
Method to list the contents of a directory on the FTP server
string | $path | Path to the local file to be stored on the FTP server |
string | $type | Return type [raw|all|folders|files] |
Définition à la ligne 1312 du fichier ftp.php.
Références JText\_(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
Référencé par listNames().
JClientFtp::listNames | ( | $path = null | ) |
Method to list the filenames of the contents of a directory on the FTP server
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
string | $path | Path local file to store on the FTP server |
Définition à la ligne 1206 du fichier ftp.php.
Références JText\_(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), listDetails(), JText\sprintf(), et JLog\WARNING.
JClientFtp::login | ( | $user = 'anonymous' , |
|
$pass = 'jftp@joomla.org' |
|||
) |
Method to login to a server once connected
string | $user | Username to login to the server |
string | $pass | Password to login to the server |
Définition à la ligne 326 du fichier ftp.php.
Références _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::mkdir | ( | $path | ) |
Method to create a directory on the FTP server
string | $path | Directory to create |
Définition à la ligne 685 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::pwd | ( | ) |
Method to retrieve the current working directory on the FTP server
Définition à la ligne 396 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::quit | ( | ) |
Method to quit and close the connection
Définition à la ligne 372 du fichier ftp.php.
Référencé par __destruct().
JClientFtp::read | ( | $remote, | |
& | $buffer | ||
) |
Method to read a file from the FTP server's contents into a buffer
string | $remote | Path to remote file to read on the FTP server |
string | &$buffer | Buffer variable to read file contents into |
Définition à la ligne 818 du fichier ftp.php.
Références $os, JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::reinit | ( | ) |
Method to reinitialise the server, ie. need to login again
NOTE: This command not available on all servers
Définition à la ligne 519 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::rename | ( | $from, | |
$to | |||
) |
Method to rename a file/folder on the FTP server
string | $from | Path to change file/folder from |
string | $to | Path to change file/folder to |
Définition à la ligne 554 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::restart | ( | $point | ) |
Method to restart data transfer at a given byte
integer | $point | Byte to restart transfer at |
Définition à la ligne 718 du fichier ftp.php.
Références JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::setOptions | ( | array | $options | ) |
Set client options
array | $options | Associative array of options to set |
Définition à la ligne 229 du fichier ftp.php.
Référencé par __construct().
JClientFtp::store | ( | $local, | |
$remote = null |
|||
) |
Method to store a file to the FTP server
string | $local | Path to local file to store on the FTP server |
string | $remote | FTP path to file to create |
Définition à la ligne 1002 du fichier ftp.php.
Références JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::syst | ( | ) |
Method to system string from the FTP server
Définition à la ligne 434 du fichier ftp.php.
Références $_response, JText\_(), _putCmd(), JLog\add(), JText\sprintf(), et JLog\WARNING.
JClientFtp::write | ( | $remote, | |
$buffer | |||
) |
Method to write a string to the FTP server
string | $remote | FTP path to file to write to |
string | $buffer | Contents to write to the FTP server |
Définition à la ligne 1115 du fichier ftp.php.
Références JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JLog\add(), JText\sprintf(), et JLog\WARNING.
|
private |
|
private |
|
private |
|
private |
Définition à la ligne 83 du fichier ftp.php.
Référencé par _passive(), et _verifyResponse().