Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe ClientHelper

Fonctions membres publiques statiques

static getCredentials ($client, $force=false)
 
static setCredentials ($client, $user, $pass)
 
static hasCredentials ($client)
 
static setCredentialsFromRequest ($client)
 

Description détaillée

Client helper class

Depuis
11.1

Documentation des fonctions membres

◆ getCredentials()

static getCredentials (   $client,
  $force = false 
)
static

Method to return the array of client layer configuration options

Paramètres
string$clientClient name, currently only 'ftp' is supported
boolean$forceForces re-creation of the login credentials. Set this to true if login credentials in the session storage have changed
Renvoie
array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
Depuis
11.1

Références $client, $config, $options, et null.

Référencé par ClientWrapper\getCredentials().

◆ hasCredentials()

static hasCredentials (   $client)
static

Method to determine if client login credentials are present

Paramètres
string$clientClient name, currently only 'ftp' is supported
Renvoie
boolean True if login credentials are available
Depuis
11.1

Références $client, $config, $options, $return, $user, elseif, et null.

Référencé par ClientWrapper\hasCredentials().

◆ setCredentials()

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

Method to set client login credentials

Paramètres
string$clientClient name, currently only 'ftp' is supported
string$userUsername
string$passPassword
Renvoie
boolean True if the given login credentials have been set and are valid
Depuis
11.1

Références $client, $config, $options, $return, $user, et FtpClient\getInstance().

Référencé par ClientWrapper\setCredentials().

◆ setCredentialsFromRequest()

static setCredentialsFromRequest (   $client)
static

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.

Paramètres
string$clientThe name of the client.
Renvoie
mixed True, if FTP settings; JError if using legacy tree.
Depuis
11.1
Exceptions

Références $client, $input, $return, $user, null, et JError\raiseWarning().

Référencé par ClientWrapper\setCredentialsFromRequest().


La documentation de cette classe a été générée à partir du fichier suivant :