ClientWrapper

Wrapper class for ClientHelper

deprecated
since

3.4

deprecated

4.0 Will be removed without replacement

package

Joomla CMS

Methods

getCredentials

Helper wrapper method for getCredentials

getCredentials(string client, bool force = false) : array
see ClientHelper::getCredentials()
since

3.4

Arguments

client

stringClient name, currently only 'ftp' is supported

force

boolForces re-creation of the login credentials. Set this to

Response

arrayClient layer configuration options, consisting of at least

hasCredentials

Helper wrapper method for hasCredentials

hasCredentials(string client) : bool
see ClientHelper::hasCredentials()
since

3.4

Arguments

client

stringClient name, currently only 'ftp' is supported

Response

boolTrue if login credentials are available

setCredentials

Helper wrapper method for setCredentials

setCredentials(string client, string user, string pass) : bool
see ClientHelper::setCredentials()
since

3.4

Arguments

client

stringClient name, currently only 'ftp' is supported

user

stringUsername

pass

stringPassword

Response

boolTrue if the given login credentials have been set and are valid

setCredentialsFromRequest

Helper wrapper method for setCredentialsFromRequest

setCredentialsFromRequest(string client) : mixed
see UserHelper::setCredentialsFromRequest()
since

3.4

throws

\InvalidArgumentExceptionif credentials invalid

Arguments

client

stringThe name of the client.

Response

mixedTrue, if FTP settings; JError if using legacy tree