PHP Class LdapTools\Operation\AuthenticationResponse

Author: Chad Sikorra ([email protected])

Show file Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property	Type	Description
$errorCode		The authentication error code, if any.
$errorMessage		The authentication error message, if any.
$isAuthenticated		Whether on not the authentication attempt succeeded.

Public Methods

Method	Description
__construct ( boolean $authenticated, null \| string $message = null, null \| integer $code = null )
getErrorCode ( ) : integer \| null
getErrorMessage ( ) : null \| string
isAuthenticated ( ) : boolean

Method Details

__construct() public method

public __construct ( boolean $authenticated, null \| string $message = null, null \| integer $code = null )
$authenticated	boolean
$message	null \| string
$code	null \| integer

getErrorCode() public method

public getErrorCode ( ) : integer \| null
return	integer \| null

getErrorMessage() public method

public getErrorMessage ( ) : null \| string
return	null \| string

isAuthenticated() public method

public isAuthenticated ( ) : boolean
return	boolean

Property Details

$errorCode protected property

The authentication error code, if any.

protected $errorCode

$errorMessage protected property

The authentication error message, if any.

protected $errorMessage

$isAuthenticated protected property

Whether on not the authentication attempt succeeded.

protected $isAuthenticated