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')

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
	$_OS = null
	$_autoAscii
	$_lineEndings = array('UNIX' => "\n", 'MAC' => "\r", 'WIN' => "\r\n")

Documentation des constructeurs et destructeur

JFTP::__construct ( $options = array() )

JFTP object constructor

Paramètres:

array $options Associative array of options to set

Depuis:: 11.1

Références $options, 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

Depuis:: 11.1

Références quit().

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

JFTP::_findMode ( $fileName )

protected

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

Paramètres:

string $fileName Name of the file

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

Depuis:: 11.1

Références $mode, et elseif.

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

Voici le graphe des appelants de cette fonction :

JFTP::_mode ( $mode )

protected

Set transfer mode

Paramètres:

integer $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

Depuis:: 11.1

Références $mode, _putCmd(), JError\raiseWarning(), et JText\sprintf().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JFTP::_passive ( )

protected

Set server to passive mode and open a data port connection

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $_timeout, $parts, JText\_(), null, JError\raiseWarning(), et JText\sprintf().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JFTP::_putCmd	(	$cmd,
		$expectedResponse
	)

protected

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

Paramètres:

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

Renvoie:: boolean True if command executed successfully

Depuis:: 11.1

Références $cmd, JText\_(), _verifyResponse(), JError\raiseWarning(), et JText\sprintf().

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 des appelants de cette fonction :

JFTP::_verifyResponse ( $expected )

protected

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

Paramètres:

mixed $expected Integer response code or array of integer response codes

Renvoie:: boolean True if response code from the server is expected

Depuis:: 11.1

Références $_timeout, $parts, null, JError\raiseWarning(), et JText\sprintf().

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 des appelants de cette fonction :

JFTP::chdir ( $path )

Method to change the current working directory on the FTP server

Paramètres:

string $path Path to change into on the server

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $path, JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::chmod	(	$path,
		$mode
	)

Method to change mode for a path on the FTP server

Paramètres:

string	$path	Path to change mode on
mixed	$mode	Octal value to change mode to, e.g. '0777', 0777 or 511 (string or integer)

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $mode, $path, JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

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

Method to connect to a FTP server

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

Depuis:: 11.1

Références _verifyResponse(), null, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::create ( $path )

Method to create an empty file on the FTP server

Paramètres:

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

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $path, JText\_(), _passive(), _putCmd(), _verifyResponse(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::delete ( $path )

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

Paramètres:

string $path Path to delete

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $path, JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

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

Paramètres:

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

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $mode, JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

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

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.

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

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

Référencé par JInstallationModelFilesystem\_chmod(), JInstallationModelConfiguration\_createConfiguration(), JInstallationModelFilesystem\checkSettings(), AdmintoolsHelperDownload\chmod(), JFolder\copy(), JFile\copy(), JFolder\create(), JoomlaupdateModelDefault\createRestorationFile(), JFile\delete(), JFolder\delete(), JInstallationModelFilesystem\detectFtpRoot(), JFile\move(), JFolder\move(), JInstallationControllerSetup\removeFolder(), JClientHelper\setCredentials(), JInstallationModelFilesystem\setFolderPermissions(), JFile\upload(), JInstallationModelFilesystem\verifyFtpSettings(), et JFile\write().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JFTP::isConnected ( )

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

Renvoie:: boolean True if connected

Depuis:: 11.1

Référencé par getInstance().

Voici le graphe des appelants de cette fonction :

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

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

Paramètres:

string	$path	Path to the local file to be stored on the FTP server
string	$type	Return type [raw\|all\|folders\|files]

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

Références $data, $file, $path, $type, JText\_(), _passive(), _putCmd(), _verifyResponse(), elseif, null, JError\raiseWarning(), et JText\sprintf().

Référencé par listNames().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de 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

Paramètres:

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

Renvoie:: string Directory listing

Depuis:: 11.1

Références $data, $key, $list, $path, JText\_(), _passive(), _putCmd(), _verifyResponse(), listDetails(), null, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

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

Method to login to a server once connected

Paramètres:

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

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $user, _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::mkdir ( $path )

Method to create a directory on the FTP server

Paramètres:

string $path Directory to create

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $path, JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::pwd ( )

Method to retrieve the current working directory on the FTP server

Renvoie:: string Current working directory

Depuis:: 11.1

Références JText\_(), _putCmd(), null, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::quit ( )

Method to quit and close the connection

Renvoie:: boolean True if successful

Depuis:: 11.1

Référencé par __destruct().

Voici le graphe des appelants de cette fonction :

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

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

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

Depuis:: 11.1

Références $mode, JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::reinit ( )

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

NOTE: This command not available on all servers

Renvoie:: boolean True if successful

Depuis:: 11.1

Références JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::rename	(	$from,
		$to
	)

Method to rename a file/folder on the FTP server

Paramètres:

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

Renvoie:: boolean True if successful

Depuis:: 11.1

Références JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::restart ( $point )

Method to restart data transfer at a given byte

Paramètres:

integer $point Byte to restart transfer at

Renvoie:: boolean True if successful

Depuis:: 11.1

Références JText\_(), _putCmd(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::setOptions ( $options )

Set client options

Paramètres:

array $options Associative array of options to set

Renvoie:: boolean True if successful

Depuis:: 11.1

Références $options.

Référencé par __construct().

Voici le graphe des appelants de cette fonction :

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

Method to store a file to the FTP server

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

Depuis:: 11.1

Références $mode, JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), null, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::syst ( )

Method to system string from the FTP server

Renvoie:: string System identifier string

Depuis:: 11.1

Références $_response, JText\_(), _putCmd(), elseif, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JFTP::write	(	$remote,
		$buffer
	)

Method to write a string to the FTP server

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

Depuis:: 11.1

Références $mode, JText\_(), _findMode(), _mode(), _passive(), _putCmd(), _verifyResponse(), JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

JFTP::$_autoAscii

private

Valeur initiale :

 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

private

JFTP::$_dataconn = null

private

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

private

JFTP::$_OS = null

private

JFTP::$_pasv = null

private

JFTP::$_response = null

private

Référencé par syst().

JFTP::$_timeout = 15

private

Référencé par _passive(), et _verifyResponse().

JFTP::$_type = null

private

JFTP::$instances = array()

staticprotected

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

ftp.php

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés statiques

Attributs privés

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres