API17:JClientHelper::getCredentials

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

JClientHelper::getCredentials

Description

Method to return the array of client layer configuration options.

Since

Synopsis

public static JClientHelper::getCredentials ($client, $force=false)

Parameter	Type	Default	Description
$client	string		Client name, currently only 'ftp' is supported
$force	boolean	false	Forces re-creation of the login credentials. Set this to true if login credentials in the session storage have changed

Returns

array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root

Defined in

libraries/joomla/client/helper.php (line 34)

• see source code in BitBucket

Referenced by

• JFolder::copy
• JFile::copy
• JFolder::create
• JFolder::delete
• JFile::delete
• JFactory::getStream
• JFolder::move
• JFile::move
• setCredentials
• JFile::upload
• JFile::write

See also

• JClientHelper
• Other versions of this method

Examples

<CodeExamplesForm />