Docs For Class JClientHelper

Description

Client helper class

since: 11.1

Located in /libraries/joomla/client/helper.php (line 19)

Method Summary

static array getCredentials (string $client, [boolean $force = false])

static boolean hasCredentials (string $client)

static boolean setCredentials (string $client, string $user, string $pass)

static mixed setCredentialsFromRequest (string $client)

Methods

static getCredentials (line 33)

Method to return the array of client layer configuration options

return: Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
since: 11.1
access: public

static array getCredentials (string $client, [boolean $force = false])

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

static hasCredentials (line 148)

Method to determine if client login credentials are present

return: True if login credentials are available
since: 11.1
access: public

static boolean hasCredentials (string $client)

string $client: Client name, currently only 'ftp' is supported

static setCredentials (line 93)

Method to set client login credentials

return: True if the given login credentials have been set and are valid
since: 11.1
access: public

static boolean setCredentials (string $client, string $user, string $pass)

string $client: Client name, currently only 'ftp' is supported
string $user: Username
string $pass: Password

static setCredentialsFromRequest (line 206)

Determine whether input fields for client settings need to be shown

If valid credentials were passed along with the request, they are saved to the session. This functions returns an exception if invalid credentials have been given or if the connection to the server failed for some other reason.

return: True, if FTP settings; JError if using legacy tree.
throws: InvalidArgumentException if credentials invalid
since: 11.1
access: public

static mixed setCredentialsFromRequest (string $client)

string $client: The name of the client.