Class AuthPlugin

Description

A class for authenticating and retrieving user information

Located in /AuthPlugin.php (line 23)


	
			
Method Summary
 AuthPlugin AuthPlugin (array $authparams)
 object The Authenticate (string $username, string $password)
Methods
Constructor AuthPlugin (line 43)

Create a new AuthPlugin object. This is as lightweight as possible.

AuthPlugin AuthPlugin (array $authparams)
  • array $authparams: An array of parameters used for this authentication method.
Authenticate (line 54)

Authenticate. Do whatever we need to authenticate a username / password.

  • return: "user" object, containing fields matching the 'usr' database table
object The Authenticate (string $username, string $password)
  • string $username: The username of the person attempting to log in
  • string $password: The password the person is trying to log in with

Documentation generated on Fri, 13 Jan 2012 23:40:12 +1300 by phpDocumentor 1.4.3