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 JAuthenticate

Description
Description | Methods (details)

Authorization class, provides an interface for the Joomla authentication system

Located in /joomla/user/authenticate.php (line 41) 

Class JObject   (Subpackage Base)

Class JAuthenticate   (Subpackage User)
Method Summary
Description | Methods (details)
Static method static object The &getInstance ()
Static method static boolean loadPlugin (string $plugin,  &$subject, object $subject)
Constructor JAuthenticate __construct ()
Method mixed authenticate (string $username, string $password)
Methods
Description | Methods (details)
Constructor __construct (line 48)

Constructor

  • access: protected
JAuthenticate __construct ()
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
authenticate (line 102)

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 (string $username, string $password)
  • string $username: The username.
  • string $password: The password.
getInstance (line 77)

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.5
  • access: public
object The &getInstance ()
loadPlugin (line 191)

Static method to load an auth plugin and attach it to the JEventDispatcher object.

This method should be invoked as: 

  $isLoaded = JAuthenticate::loadPlugin($plugin, $subject);

  • return: True if plugin is loaded
  • since: 1.5
  • access: public
boolean loadPlugin (string $plugin,  &$subject, object $subject)
  • string $plugin: The authentication plugin to use.
  • object $subject: Observable object for the plugin to observe
  • &$subject

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 20:52:44 +0000 by phpDocumentor 1.3.1