ClientWrapper
Wrapper class for ClientHelper
| package |
Joomla.Platform |
|---|---|
| subpackage |
Client |
| since |
3.4 |
| deprecated |
4.0 Will be removed without replacement |
Methods
getCredentials
Helper wrapper method for getCredentials
getCredentials(string $client, boolean $force = false) : array
| see | \Joomla\CMS\Client\ClientHelper::getCredentials() |
|---|---|
| since |
3.4 |
Arguments
- $client
stringClient name, currently only 'ftp' is supported- $force
booleanForces 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) : boolean
| see | \Joomla\CMS\Client\ClientHelper::hasCredentials() |
|---|---|
| since |
3.4 |
Arguments
- $client
stringClient name, currently only 'ftp' is supported
Response
booleanTrue if login credentials are available
setCredentials
Helper wrapper method for setCredentials
setCredentials(string $client, string $user, string $pass) : boolean
| see | \Joomla\CMS\Client\ClientHelper::setCredentials() |
|---|---|
| since |
3.4 |
Arguments
- $client
stringClient name, currently only 'ftp' is supported- $user
stringUsername- $pass
stringPassword
Response
booleanTrue if the given login credentials have been set and are valid
setCredentialsFromRequest
Helper wrapper method for setCredentialsFromRequest
setCredentialsFromRequest(string $client) : mixed
| see | \Joomla\CMS\Client\UserHelper::setCredentialsFromRequest() |
|---|---|
| since |
3.4 |
| throws |
|
Arguments
- $client
stringThe name of the client.
Response
mixedTrue, if FTP settings; JError if using legacy tree