Class Result

Summary

Fully Qualified Name: Zend\Authentication\Result

Description

Methods

Name Description Defined By
__construct() Sets the result code, identity, and failure messages Result
getCode() getCode() - Get the result code for this authentication attempt Result
getIdentity() Returns the identity used in the authentication attempt Result
getMessages() Returns an array of string reasons why the authentication attempt was unsuccessful Result
isValid() Returns whether the result represents a successful authentication attempt Result

Method Details

__construct()

Sets the result code, identity, and failure messages

Parameter Name Type Description
$code int
$identity mixed
$messages array

Returns:

getCode()

getCode() - Get the result code for this authentication attempt

Returns: int

getIdentity()

Returns the identity used in the authentication attempt

Returns: mixed

getMessages()

Returns an array of string reasons why the authentication attempt was unsuccessful

If authentication was successful, this method returns an empty array.

Returns: array

isValid()

Returns whether the result represents a successful authentication attempt

Returns: bool

Top