Référence de la classe JFTP

Graphe d'héritage de JFTP:

Graphe de collaboration de JFTP:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• __destruct ()
• & getInstance ($host= '127.0.0.1', $port= '21', $options=null, $user=null, $pass=null)
• setOptions ($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')
• _putCmd ($cmd, $expectedResponse)
• _verifyResponse ($expected)
• _passive ()
• _findMode ($fileName)
• _mode ($mode)

Attributs publics

• $_conn = null
• $_dataconn = null
• $_pasv = null
• $_response = null
• $_timeout = 15
• $_type = null
• $_OS = null
• $_autoAscii = array ("asp", "bat", "c", "cpp", "csv", "h", "htm", "html", "shtml", "ini", "inc", "log", "php", "php3", "pl", "perl", "sh", "sql", "txt", "xhtml", "xml")
• $_lineEndings = array ('UNIX' => "\n", 'MAC' => "\r", 'WIN' => "\r\n")

---

Documentation des constructeurs et destructeur

JFTP::__construct

(

$

options = array()

)

JFTP object constructor

protected

Paramètres:

array

$options

Associative array of options to set

Depuis:

1.5

Références elseif, jimport(), JLoader::load(), et setOptions().

Voici le graphe d'appel pour cette fonction :

JFTP::__destruct

(

)

JFTP object destructor

Closes an existing connection, if we have one

protected

Depuis:

1.5

Références quit().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JFTP::_findMode

(

$

fileName

)

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

private

Paramètres:

string

$fileName

Name of the file

Renvoie:

integer Transfer-mode for this filetype [FTP_ASCII|FTP_BINARY]

Références $ext, et elseif.

Référencé par get(), read(), store(), et write().

Voici le graphe d'appel pour cette fonction :

JFTP::_mode

(

$

mode

)

Set transfer mode

private

Paramètres:

int

$mode

Integer representation of data transfer mode [1:Binary|0:Ascii] Defined constants can also be used [FTP_BINARY|FTP_ASCII]

Renvoie:

boolean True if successful

Références _putCmd(), et JError::raiseWarning().

Référencé par get(), read(), store(), et write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JFTP::_passive

(

)

Set server to passive mode and open a data port connection

private

Renvoie:

boolean True if successful

Références $parts, et JError::raiseWarning().

Référencé par create(), get(), listDetails(), listNames(), read(), store(), et write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JFTP::_putCmd	(	$	cmd,
		$	expectedResponse
	)

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

private

Paramètres:

string	$cmd	Command to send to the FTP server
mixed	$expected	Integer response code or array of integer response codes

Renvoie:

boolean True if command executed successfully

Références $cmd, _verifyResponse(), et JError::raiseWarning().

Référencé par _mode(), chdir(), chmod(), create(), delete(), get(), listDetails(), listNames(), login(), mkdir(), pwd(), read(), reinit(), rename(), restart(), store(), syst(), et write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JFTP::_verifyResponse

(

$

expected

)

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

private

Paramètres:

mixed

$expected

Integer response code or array of integer response codes

Renvoie:

boolean True if response code from the server is expected

Références $parts, et JError::raiseWarning().

Référencé par _putCmd(), connect(), create(), get(), listDetails(), listNames(), read(), store(), et write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JFTP::chdir

(

$

path

)

Method to change the current working directory on the FTP server

public

Paramètres:

string

$path

Path to change into on the server

Renvoie:

boolean True if successful

Références $path, _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::chmod	(	$	path,
		$	mode
	)

Method to change mode for a path on the FTP server

public

Paramètres:

string	$path	Path to change mode on
	string/int	$mode Octal value to change mode to, e.g. '0777', 0777 or 511

Renvoie:

boolean True if successful

Références $path, _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::connect	(	$	host = '127.0.0.1',
		$	port = 21
	)

Method to connect to a FTP server

public

Paramètres:

string	$host	Host to connect to [Default: 127.0.0.1]
string	$port	Port to connect on [Default: port 21]

Renvoie:

boolean True if successful

Références $host, _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::create

(

$

path

)

Method to create an empty file on the FTP server

public

Paramètres:

string

$path

Path local file to store on the FTP server

Renvoie:

boolean True if successful

Références $path, _passive(), _putCmd(), _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::delete

(

$

path

)

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

public

Paramètres:

string

$path

Path to delete

Renvoie:

boolean True if successful

Références $path, _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::get	(	$	local,
		$	remote
	)

Method to get a file from the FTP server and save it to a local file

public

Paramètres:

string	$local	Path to local file to save remote file as
string	$remote	Path to remote file to get on the FTP server

Renvoie:

boolean True if successful

Réimplémentée à partir de JObject.

Références _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

& JFTP::getInstance	(	$	host = '127.0.0.1',
		$	port = '21',
		$	options = null,
		$	user = null,
		$	pass = null
	)

Returns a reference to the global FTP connector object, only creating it if it doesn't already exist.

This method must be invoked as:

  $ftp = &JFTP::getInstance($host);

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.

Paramètres:

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

Renvoie:

JFTP The FTP Client object.

Depuis:

1.5

Références $host, $return, $user, et isConnected().

Référencé par JInstallationHelper::_chmod(), JFolder::copy(), JFile::copy(), JFolder::create(), JFolder::delete(), JFile::delete(), JInstallationHelper::findFtpRoot(), JInstallationHelper::FTPVerify(), JFolder::move(), JFile::move(), JInstallationModel::saveConfig(), JClientHelper::setCredentials(), JInstallationHelper::setDirPerms(), JFile::upload(), et JFile::write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JFTP::isConnected

(

)

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

public

Renvoie:

boolean True if connected

Depuis:

1.5

Référencé par getInstance().

Voici le graphe d'appel pour cette fonction :

JFTP::listDetails	(	$	path = null,
		$	type = 'all'
	)

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

public

Paramètres:

string	$path	Path local file to store on the FTP server
string	$type	Return type [raw|all|folders|files]
boolean	$search	Recursively search subdirectories

Renvoie:

mixed : if $type is raw: string Directory listing, otherwise array of string with file-names

Références $data, $file, $k, $path, $type, _passive(), _putCmd(), _verifyResponse(), elseif, et JError::raiseWarning().

Référencé par listNames().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

public

Paramètres:

string

$path

Path local file to store on the FTP server

Renvoie:

string Directory listing

Références $data, $list, $path, _passive(), _putCmd(), _verifyResponse(), listDetails(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::login	(	$	user = 'anonymous',
		$	pass = 'jftp@joomla.org'
	)

Method to login to a server once connected

public

Paramètres:

string	$user	Username to login to the server
string	$pass	Password to login to the server

Renvoie:

boolean True if successful

Références $user, _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::mkdir

(

$

path

)

Method to create a directory on the FTP server

public

Paramètres:

string

$path

Directory to create

Renvoie:

boolean True if successful

Références $path, _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::pwd

(

)

Method to retrieve the current working directory on the FTP server

public

Renvoie:

string Current working directory

Références _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::quit

(

)

Method to quit and close the connection

public

Renvoie:

boolean True if successful

Référencé par __destruct().

Voici le graphe d'appel pour cette fonction :

JFTP::read	(	$	remote,
		&$	buffer
	)

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

public

Paramètres:

string	$remote	Path to remote file to read on the FTP server
string	$buffer	Buffer variable to read file contents into

Renvoie:

boolean True if successful

Références _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::reinit

(

)

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

NOTE: This command not available on all servers

public

Renvoie:

boolean True if successful

Références _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::rename	(	$	from,
		$	to
	)

Method to rename a file/folder on the FTP server

public

Paramètres:

string	$from	Path to change file/folder from
string	$to	Path to change file/folder to

Renvoie:

boolean True if successful

Références _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::restart

(

$

point

)

Method to restart data transfer at a given byte

public

Paramètres:

int

$point

Byte to restart transfer at

Renvoie:

boolean True if successful

Références _putCmd(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::setOptions

(

$

options

)

Set client options

public

Paramètres:

array

$options

Associative array of options to set

Renvoie:

boolean True if successful

Référencé par __construct().

Voici le graphe d'appel pour cette fonction :

JFTP::store	(	$	local,
		$	remote = null
	)

Method to store a file to the FTP server

public

Paramètres:

string	$local	Path to local file to store on the FTP server
string	$remote	FTP path to file to create

Renvoie:

boolean True if successful

Références _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::syst

(

)

Method to system string from the FTP server

public

Renvoie:

string System identifier string

Références _putCmd(), elseif, et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JFTP::write	(	$	remote,
		$	buffer
	)

Method to write a string to the FTP server

public

Paramètres:

string	$remote	FTP path to file to write to
string	$buffer	Contents to write to the FTP server

Renvoie:

boolean True if successful

Références _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

JFTP::$_autoAscii = array ("asp", "bat", "c", "cpp", "csv", "h", "htm", "html", "shtml", "ini", "inc", "log", "php", "php3", "pl", "perl", "sh", "sql", "txt", "xhtml", "xml")

JFTP::$_conn = null

JFTP::$_dataconn = null

JFTP::$_lineEndings = array ('UNIX' => "\n", 'MAC' => "\r", 'WIN' => "\r\n")

JFTP::$_OS = null

JFTP::$_pasv = null

JFTP::$_response = null

JFTP::$_timeout = 15

JFTP::$_type = null

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/joomla/client/ftp.php