Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JClientHelper

Description
Description | Methods (details)

Client helper class

Located in /joomla/client/helper.php (line 23) 

Class JClientHelper   (Subpackage Client)
Method Summary
Description | Methods (details)
Static method static array getCredentials (string $client, [boolean $force = false])
Static method static boolean hasCredentials (string $client)
Static method static boolean setCredentials (string $client, string $user, string $pass)
Static method static boolean|JExeption &setCredentialsFromRequest ( $client)
Methods
Description | Methods (details)
getCredentials (line 36)

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: 1.5
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
hasCredentials (line 160)

Method to determine if client login credentials are present

  • return: True if login credentials are available
  • since: 1.5
boolean hasCredentials (string $client)
  • string $client: Client name, currently only 'ftp' is supported
setCredentials (line 103)

Method to set client login credentials

  • return: True if the given login credentials have been set and are valid
  • since: 1.5
boolean setCredentials (string $client, string $user, string $pass)
  • string $client: Client name, currently only 'ftp' is supported
  • string $user: Username
  • string $pass: Password
setCredentialsFromRequest (line 221)

Determine wether 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 exeption if invalid credentials have been given or if the connection to the server failed for some other reason.

  • return: True, if FTP settings should be shown, or an exeption
  • since: 1.5
boolean|JExeption &setCredentialsFromRequest ( $client)
  • $client
Documentation generated on Mon, 05 Mar 2007 21:06:02 +0000 by phpDocumentor 1.3.1