IAuthentication
in
Authentication method interface.
Table of Contents
Methods
- canTryNextAuthenticationMethod() : bool
- Determines if the next authentication method could be tried if this one failed.
- getError() : string
- Gets the last authentication error
- getUserID() : int
- Gets the user_id matching the authentication method
- isValid() : bool
- Determines if an user has been authenticated.
Methods
canTryNextAuthenticationMethod()
Determines if the next authentication method could be tried if this one failed.
public
canTryNextAuthenticationMethod() : bool
This allows when a method has failed in such a way the user must be warned to warn it, returning false.
Return values
bool —true if authentication can go on to the next method; otherwise, false
getError()
Gets the last authentication error
public
getError() : string
Return values
string —The last authentication error
getUserID()
Gets the user_id matching the authentication method
public
getUserID() : int
Return values
int —the authenticated user ID
isValid()
Determines if an user has been authenticated.
public
isValid() : bool
Return values
bool —true if the user has successfully been authenticated; otherwise, false.