Interface ResultInterface
Constants
-
FAILURE_CREDENTIALS_INVALID ¶
'FAILURE_CREDENTIALS_INVALID'
Failure due to invalid credentials being supplied.
-
FAILURE_CREDENTIALS_MISSING ¶
'FAILURE_CREDENTIALS_MISSING'
The authentication credentials were not found in the request.
-
FAILURE_IDENTITY_NOT_FOUND ¶
'FAILURE_IDENTITY_NOT_FOUND'
Failure due to identity not being found.
-
FAILURE_OTHER ¶
'FAILURE_OTHER'
General failure due to any other circumstances.
-
SUCCESS ¶
'SUCCESS'
Authentication success.
Method Summary
-
getData() public
Returns the identity data used in the authentication attempt.
-
getErrors() public
Returns an array of string reasons why the authentication attempt was unsuccessful.
-
getStatus() public
Get the result status for this authentication attempt.
-
isValid() public
Returns whether the result represents a successful authentication attempt.
Method Detail
getData() ¶ public
getData(): ArrayAccess|array|null
Returns the identity data used in the authentication attempt.
Returns
ArrayAccess|array|null
getErrors() ¶ public
getErrors(): array
Returns an array of string reasons why the authentication attempt was unsuccessful.
If authentication was successful, this method returns an empty array.
Returns
array
getStatus() ¶ public
getStatus(): string
Get the result status for this authentication attempt.
Returns
string
isValid() ¶ public
isValid(): bool
Returns whether the result represents a successful authentication attempt.
Returns
bool