Method |
Description |
|
__construct ( ) |
|
|
authenticate ( ) |
Returns the unique id assigned to the user in the database. |
|
authorizeToken ( $TokenKey ) : boolean |
|
|
clearNonces ( $TokenKey ) |
|
|
createToken ( $TokenType, $ProviderKey, null $UserKey = null, boolean $Authorized = false ) : array | boolean |
|
|
currentStep ( ) |
|
|
dataSourceType ( ) : string |
|
|
deAuthenticate ( ) |
|
|
deleteToken ( $ProviderKey, $UserKey, $TokenType ) |
|
|
failedResponse ( ) |
What to do if the entry/auth/* page is triggered but login is denied or fails. |
|
fetchData ( $DataSource, array $DirectSupplied = [] ) |
|
|
getAuthenticationSchemeAlias ( ) : string |
|
|
getNonce ( ) : array | boolean | stdClass |
|
|
getProvider ( null $ProviderKey = null, boolean $Force = false ) : array | boolean | stdClass |
|
|
getProviderKey ( ) : boolean |
|
|
getProviderSecret ( ) : boolean |
|
|
getProviderUrl ( ) : boolean |
|
|
getProviderValue ( $Key, boolean $Default = false ) : boolean |
|
|
getToken ( ) : array | boolean | stdClass |
|
|
getURL ( $URLType ) : mixed |
Get one of the three Forwarding URLs (Registration, SignIn, SignOut). |
|
getValue ( $Key, boolean $Default = false ) : boolean |
|
|
hookDataField ( $InternalFieldName, $DataFieldName, boolean $DataFieldRequired = true ) |
|
|
loginResponse ( ) |
What to do if entry/auth/* is called while the user is logged out. |
|
logoutResponse ( ) |
What to do if the entry/leave/* page is triggered for a user that is logged in and successfully logs out. |
|
lookupNonce ( $TokenKey, null $Nonce = null ) : boolean |
|
|
lookupToken ( $ProviderKey, $UserKey, null $TokenType = null ) : array | boolean | stdClass |
|
|
partialResponse ( ) |
What to do after part 1 of a 2 part authentication process. |
|
repeatResponse ( ) |
What to do if the entry/auth/* page is triggered for a user that is already logged in. |
|
requireLogoutTransientKey ( ) : boolean |
|
|
setIdentity ( $UserID, boolean $Persist = true ) |
|
|
setNonce ( $TokenKey, $Nonce, null $Timestamp = null ) : boolean |
|
|
successResponse ( ) |
What to do after authentication has succeeded. |
|
wakeUp ( ) |
|
|