Docs For Class JAuthenticate

Description

Authorization class, provides an interface for the Joomla authentication system

since: 1.1
author: Louis Landry <[email protected]>

Located in /application/user/authenticate.php (line 24)

JObject
   |
   --JAuthenticate

Method Summary

JAuthenticate __construct ()

mixed authenticate (array $credentials)

object The &getInstance ()

boolean login (array $credentials)

boolean logout ()

Methods

Constructor __construct (line 31)

Constructor

access: protected

JAuthenticate __construct ()

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

authenticate (line 252)

Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.

return: Integer userid for valid user if credentials are valid or boolean false if they are not
since: 1.1
access: public

mixed authenticate (array $credentials)

array $credentials: The credentials to authenticate.

getInstance (line 304)

Returns a reference to a global authentication object, only creating it if it doesn't already exist.

This method must be invoked as:

  $auth = &JAuthenticate::getInstance();

return: global JAuthenticate object
since: 1.1
access: public
static:

object The &getInstance ()

login (line 78)

JAuthenticate Login Method

Username and Password are sent as credentials (along with other possibilities) to each observer (JAuthenticatePlugin) for user validation. Successful validation will update the current session with the user details

 Credentials Array
 	['username']
 	['password']
 	['userid']	*optional
 	['realm']	*optional

return: True on success
since: 1.1
access: public

boolean login (array $credentials)

array $credentials: Array of credentials to authenticate

logout (line 196)

Logs a user out by asking all obvserving objects to run their respective logout routines.

return: True on success
since: 1.1
access: public

boolean logout ()

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::JObject()
JObject::get()
JObject::set()
JObject::toString()
JObject::__destruct()