Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JAuthentication

Description

Authenthication class, provides an interface for the Joomla authentication system

  • since: 1.5

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

Class JObject   (Subpackage Base)

Abstract class JObservable   (Subpackage Base)
   
   Class JAuthentication   (Subpackage User)
Method Summary
Static method static object The &getInstance ()
Constructor JAuthentication __construct ()
Method mixed authenticate (array $credentials,  $options)
Variables

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
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()
Support Joomla!