JClientHelper

From Joomla! Documentation
Revision as of 06:50, 14 December 2008 by Batch1211 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

JClientHelper is a helper class to get, set and check for client credentials.

Contents

Defined in

/joomla/client/helper.php


Methods

Method name Description
getCredentials Returns Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
hasCredentials Method to determine if client login credentials are present
setCredentials Method to set client login credentials. Returns True if the given login credentials have been set and are valid.
setCredentialsFromRequest 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.

Importing

jimport( 'joomla.client.helper' );

See also

Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox