Vaskovsky Web Application  3.17.0306
Public Member Functions | List of all members
AVaskovsky\WebApplication\AbstractAuthentication Interface Reference

An abstract authentication. More...

Inheritance diagram for AVaskovsky\WebApplication\AbstractAuthentication:
Inheritance graph
[legend]

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$nameis an attribute name.
Exceptions
InvalidArgumentExceptionif $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$passwordis a password string.
Exceptions
InvalidArgumentExceptionif $password is null.
Returns
a string that contains the password hash; never null.

Implemented in AVaskovsky\WebApplication\BasicAuthentication.

AVaskovsky\WebApplication\AbstractAuthentication::signOut ( )

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