Xataface 2.0
Xataface Application Framework
Public Member Functions | Static Public Member Functions | Data Fields
Dataface_AuthenticationTool Class Reference

Public Member Functions

 Dataface_AuthenticationTool ($params=array())
 setAuthType ($type)
 getCredentials ()
 checkCredentials ()
 setPassword ($password)
 authenticate ()
 isLoggedIn ()
 showLoginPrompt ($msg='')
getLoggedInUser ()
 getLoggedInUsername ()
 _createFailedLoginsTable ()
 flagFailedAttempt ($credentials)
 clearFailedAttempts ()
 isLockedOut ()
 getEmailColumn ()

Static Public Member Functions

static & getInstance ($params=array())

Data Fields

 $authType = 'basic'
 $conf
 $delegate
 $usersTable
 $usernameColumn
 $passwordColumn
 $userLevelColumn
 $authEnabled = true

Detailed Description

Definition at line 30 of file AuthenticationTool.php.


Member Function Documentation

_createFailedLoginsTable ( )

Definition at line 414 of file AuthenticationTool.php.

authenticate ( )

Definition at line 189 of file AuthenticationTool.php.

checkCredentials ( )

Definition at line 123 of file AuthenticationTool.php.

clearFailedAttempts ( )

Definition at line 436 of file AuthenticationTool.php.

Dataface_AuthenticationTool ( params = array())

Definition at line 79 of file AuthenticationTool.php.

flagFailedAttempt ( credentials)

Definition at line 424 of file AuthenticationTool.php.

getCredentials ( )

Definition at line 112 of file AuthenticationTool.php.

getEmailColumn ( )

Definition at line 453 of file AuthenticationTool.php.

static& getInstance ( params = array()) [static]

Definition at line 67 of file AuthenticationTool.php.

& getLoggedInUser ( )

Returns reference to a Dataface_Record object of the currently logged in user's record.

Definition at line 380 of file AuthenticationTool.php.

getLoggedInUsername ( )

Definition at line 399 of file AuthenticationTool.php.

isLockedOut ( )

Definition at line 442 of file AuthenticationTool.php.

isLoggedIn ( )

Indicates whether there is a user logged in or not.

Definition at line 333 of file AuthenticationTool.php.

setAuthType ( type)

Definition at line 89 of file AuthenticationTool.php.

setPassword ( password)

Definition at line 168 of file AuthenticationTool.php.

showLoginPrompt ( msg = '')

Displays the login prompt for an application.

Parameters:
$msgOptional error message to display. e.g. 'Incorrect password'

Definition at line 346 of file AuthenticationTool.php.


Field Documentation

$authEnabled = true

A flag to indicate if authentication is enabled.

Definition at line 65 of file AuthenticationTool.php.

$authType = 'basic'

Definition at line 32 of file AuthenticationTool.php.

$conf

Definition at line 34 of file AuthenticationTool.php.

$delegate

Delegate object that can override login functionality.

Definition at line 38 of file AuthenticationTool.php.

$passwordColumn

Name of the column that contains the password

Definition at line 53 of file AuthenticationTool.php.

$userLevelColumn

Optional name of the column that contains the level of the user.

Definition at line 58 of file AuthenticationTool.php.

$usernameColumn

Name of the column that contains the username

Definition at line 48 of file AuthenticationTool.php.

$usersTable

Name of the table that contains the Users records.

Definition at line 43 of file AuthenticationTool.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations