1. class
  2. Joomla
  3. CMS
  4. Client
  5. ClientWrapper

ClientWrapper

class ClientWrapper

Wrapper class for ClientHelper

Methods

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

Helper wrapper method for getCredentials

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

Helper wrapper method for setCredentials

boolean
hasCredentials( string $client)

Helper wrapper method for hasCredentials

mixed
setCredentialsFromRequest( string $client)

Helper wrapper method for setCredentialsFromRequest

Details

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

Helper wrapper method for getCredentials

Parameters

string $client Client name, currently only 'ftp' is supported
boolean $force Forces re-creation of the login credentials. Set this to

Return Value

array Client layer configuration options, consisting of at least

See also

ClientHelper::getCredentials()

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

Helper wrapper method for setCredentials

Parameters

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

Return Value

boolean True if the given login credentials have been set and are valid

See also

ClientHelper::setCredentials()

boolean hasCredentials( string $client)

Helper wrapper method for hasCredentials

Parameters

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

Return Value

boolean True if login credentials are available

See also

ClientHelper::hasCredentials()

mixed setCredentialsFromRequest( string $client)

Helper wrapper method for setCredentialsFromRequest

Parameters

string $client The name of the client.

Return Value

mixed True, if FTP settings; JError if using legacy tree

Exceptions

InvalidArgumentException if credentials invalid

See also

UserHelper::setCredentialsFromRequest()