PHP Class Thruway\Authentication\AuthenticationDetails

Inheritance: implements JsonSerializable
Exibir arquivo Open project: voryx/thruway Class Usage Examples

Public Methods

Method Description
__construct ( )
addAuthRole ( $authRole )
createAnonymous ( ) : AuthenticationDetails Create anonymous
getAuthExtra ( ) : stdClass
getAuthId ( ) : mixed Get authentication ID
getAuthMethod ( ) : mixed Get authentication method
getAuthRole ( ) : mixed
getAuthRoles ( ) : array
getChallenge ( ) : mixed Get challenge data
getChallengeDetails ( ) : mixed Get challenge details
hasAuthRole ( $authRole ) : boolean
jsonSerialize ( ) : mixed (PHP 5 >= 5.4.0)
Specify data which should be serialized to JSON
setAuthExtra ( stdClass $authExtra )
setAuthId ( mixed $authId ) Set authentication ID
setAuthMethod ( mixed $authMethod ) Set authentication method
setAuthRoles ( array $authRoles )
setChallenge ( mixed $challenge ) Set challenge info
setChallengeDetails ( mixed $challengeDetails ) Set challenge details

Method Details

__construct() public method

public __construct ( )

addAuthRole() public method

public addAuthRole ( $authRole )
$authRole

createAnonymous() public static method

Create anonymous
public static createAnonymous ( ) : AuthenticationDetails
return AuthenticationDetails

getAuthExtra() public method

public getAuthExtra ( ) : stdClass
return stdClass

getAuthId() public method

Get authentication ID
public getAuthId ( ) : mixed
return mixed

getAuthMethod() public method

Get authentication method
public getAuthMethod ( ) : mixed
return mixed

getAuthRole() public method

public getAuthRole ( ) : mixed
return mixed

getAuthRoles() public method

public getAuthRoles ( ) : array
return array

getChallenge() public method

Get challenge data
public getChallenge ( ) : mixed
return mixed

getChallengeDetails() public method

Get challenge details
public getChallengeDetails ( ) : mixed
return mixed

hasAuthRole() public method

public hasAuthRole ( $authRole ) : boolean
$authRole
return boolean

jsonSerialize() public method

(PHP 5 >= 5.4.0)
Specify data which should be serialized to JSON
See link: http://php.net/manual/en/jsonserializable.jsonserialize.php
public jsonSerialize ( ) : mixed
return mixed data which can be serialized by json_encode, which is a value of any type other than a resource.

setAuthExtra() public method

public setAuthExtra ( stdClass $authExtra )
$authExtra stdClass

setAuthId() public method

Set authentication ID
public setAuthId ( mixed $authId )
$authId mixed

setAuthMethod() public method

Set authentication method
public setAuthMethod ( mixed $authMethod )
$authMethod mixed

setAuthRoles() public method

public setAuthRoles ( array $authRoles )
$authRoles array

setChallenge() public method

Set challenge info
public setChallenge ( mixed $challenge )
$challenge mixed

setChallengeDetails() public method

Set challenge details
public setChallengeDetails ( mixed $challengeDetails )
$challengeDetails mixed