AuthenticationServiceInterface Interface Reference

Provides an API for authentication and identity management. More...

Public Member Functions
	authenticate ()
	Authenticates and provides an authentication result.
	hasIdentity ()
	Returns true if and only if an identity is available.
	getIdentity ()
	Returns the authenticated identity or null if no identity is available.
	clearIdentity ()
	Clears the identity.

Detailed Description

Provides an API for authentication and identity management.

Member Function Documentation

authenticate

(

)

Authenticates and provides an authentication result.

Returns

Result

clearIdentity

(

)

Clears the identity.

Returns

void

Implemented in AuthenticationService.

getIdentity

(

)

Returns the authenticated identity or null if no identity is available.

Returns

mixed|null

Implemented in AuthenticationService.

hasIdentity

(

)

Returns true if and only if an identity is available.

Returns

bool

Implemented in AuthenticationService.