Authenthication class, provides an interface for the Joomla authentication system

• author: Louis Landry <louis.landry@joomla.org>
• since: 1.5

Located in /joomla/user/authentication.php (line 42)

 JObject   (Subpackage Base)

 JObservable   (Subpackage Base)
   
    JAuthentication   (Subpackage User)

Inherited Variables

Inherited from JObject

JObject::$_errors

Constructor __construct (line 49)

Constructor

• access: protected

JAuthentication __construct ()

---

Redefinition of:

JObservable::__construct()

Constructor

authenticate (line 95)

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.5
• access: public

mixed authenticate (array $credentials,  $options)

• array $credentials: Array holding the user credentials
• $options

getInstance (line 70)

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

This method must be invoked as:

  $auth = &JAuthentication::getInstance();

• return: global JAuthentication object
• since: 1.5
• access: public

object The &getInstance ()

Inherited Methods

Inherited From JObservable

JObservable::__construct()
JObservable::attach()
JObservable::detach()
JObservable::getState()
JObservable::notify()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()