Andrew's Web Libraries (AWL)
Loading...
Searching...
No Matches
AuthPlugin Class Reference

Public Member Functions

 __construct ( $authparams)
 
 Authenticate ( $username, $password)
 

Public Attributes

 $usr
 
 $success
 

Detailed Description

Definition at line 23 of file AuthPlugin.php.

Constructor & Destructor Documentation

◆ __construct()

AuthPlugin::__construct (   $authparams)

#- #+ @access public #- Create a new AuthPlugin object. This is as lightweight as possible.

Parameters
array$authparamsAn array of parameters used for this authentication method.

Definition at line 43 of file AuthPlugin.php.

Member Function Documentation

◆ Authenticate()

AuthPlugin::Authenticate (   $username,
  $password 
)

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

Parameters
string$usernameThe username of the person attempting to log in
string$passwordThe password the person is trying to log in with
Returns
object The "user" object, containing fields matching the 'usr' database table

Definition at line 54 of file AuthPlugin.php.

Member Data Documentation

◆ $success

AuthPlugin::$success

Definition at line 29 of file AuthPlugin.php.

◆ $usr

AuthPlugin::$usr

#+ @access private

Definition at line 28 of file AuthPlugin.php.


The documentation for this class was generated from the following file: