API17:JClientHelper::getCredentials

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JClientHelper::getCredentials

Description

Method to return the array of client layer configuration options.

public static function 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 on line 34 of libraries/joomla/client/helper.php
• Since
• 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::getCredentials source code on BitBucket
• Class JClientHelper
• Subpackage Client
• Other versions of JClientHelper::getCredentials

User contributed notes

<CodeExamplesForm />