AVaskovsky\WebApplication\AbstractAuthentication Interface Reference

An abstract authentication. More...

Inheritance diagram for AVaskovsky\WebApplication\AbstractAuthentication:

Public Member Functions
	authenticate ()
	Performs authentication. More...
	getAccountAttribute ($name)
	Returns an account attribute. More...
	getPasswordHash ($password)
	Creates a new password hash. More...
	signOut ()
	Signs out. More...

Detailed Description

An abstract authentication.

Author

Alexey Vaskovsky

Definition at line 23 of file AbstractAuthentication.php.

Member Function Documentation

AVaskovsky\WebApplication\AbstractAuthentication::authenticate

(

)

Performs authentication.

Returns

true if user is authenticated; false otherwise.

Implemented in AVaskovsky\WebApplication\BasicAuthentication.

AVaskovsky\WebApplication\AbstractAuthentication::getAccountAttribute

(

$name

)

Returns an account attribute.

This method performs authentication if user is not authenticated yet, loads account attributes and returns a value of the specified attribute.

Parameters

string

$name

is an attribute name.

Exceptions

InvalidArgumentException

if $name is empty.

Returns

the attribute value or null if the authentication failed.

Implemented in AVaskovsky\WebApplication\BasicAuthentication.

AVaskovsky\WebApplication\AbstractAuthentication::getPasswordHash

(

$password

)

Creates a new password hash.

Parameters

string

$password

is a password string.

Exceptions

InvalidArgumentException

if $password is null.

Returns

a string that contains the password hash; never null.

Implemented in AVaskovsky\WebApplication\BasicAuthentication.

AVaskovsky\WebApplication\AbstractAuthentication::signOut

(

)

Signs out.

See also

authenticate()

Implemented in AVaskovsky\WebApplication\BasicAuthentication.

---

The documentation for this interface was generated from the following file:

• AbstractAuthentication.php