PHP Class PMA\libraries\plugins\AuthenticationPlugin

Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method Description
auth ( ) : boolean Displays authentication form
authCheck ( ) : boolean Gets advanced authentication settings
authFails ( ) : boolean User is not allowed to login to MySQL -> authentication failed
authSetUser ( ) : boolean Set the user and password after last checkings if required
getErrorMessage ( ) : string Returns error message for failed authentication.
getLoginFormURL ( ) : string Returns URL for login form.
handlePasswordChange ( string $password ) : void Callback when user changes password.
logOut ( ) : void Perform logout
setSessionAccessTime ( ) : void Store session access time in session.
storeUserCredentials ( ) : void Stores user credentials after successful login.

Method Details

auth() abstract public method

Displays authentication form
abstract public auth ( ) : boolean
return boolean

authCheck() abstract public method

Gets advanced authentication settings
abstract public authCheck ( ) : boolean
return boolean

authFails() abstract public method

User is not allowed to login to MySQL -> authentication failed
abstract public authFails ( ) : boolean
return boolean

authSetUser() abstract public method

Set the user and password after last checkings if required
abstract public authSetUser ( ) : boolean
return boolean

getErrorMessage() public method

Returns error message for failed authentication.
public getErrorMessage ( ) : string
return string

getLoginFormURL() public method

Returns URL for login form.
public getLoginFormURL ( ) : string
return string

handlePasswordChange() public method

Callback when user changes password.
public handlePasswordChange ( string $password ) : void
$password string New password to set
return void

logOut() public method

Perform logout
public logOut ( ) : void
return void

setSessionAccessTime() public method

Tries to workaround PHP 5 session garbage collection which looks at the session file's last modified time
public setSessionAccessTime ( ) : void
return void

storeUserCredentials() public method

Stores user credentials after successful login.
public storeUserCredentials ( ) : void
return void