AbstractUsernamePasswordAuthenticationStrategy

Implements \Joomla\Authentication\AuthenticationStrategyInterface

Abstract AuthenticationStrategy for username/password based authentication

abstract
since

1.1.0

Methods

__construct

Constructor.

__construct(\Joomla\Authentication\Password\HandlerInterface $passwordHandler = null) 
since

1.2.0

Arguments

$passwordHandler

\Joomla\Authentication\Password\HandlerInterfaceThe password handler.

doAuthenticate

Attempt to authenticate the username and password pair.

doAuthenticate(string $username, string $password) : string|boolean
since

1.1.0

Arguments

$username

stringThe username to authenticate.

$password

stringThe password to attempt authentication with.

Response

string|booleanA string containing a username if authentication is successful, false otherwise.

getHashedPassword

Retrieve the hashed password for the specified user.

getHashedPassword(string $username) : string|boolean
abstract
since

1.1.0

Arguments

$username

stringUsername to lookup.

Response

string|booleanHashed password on success or boolean false on failure.

getResult

Get the status of the last authentication attempt.

getResult() : integer
since

1.1.0

Response

integerAuthentication class constant result.

verifyPassword

Attempt to verify the username and password pair.

verifyPassword(string $username, string $password, string $hashedPassword) : boolean
since

1.1.0

Arguments

$username

stringThe username to authenticate.

$password

stringThe password to attempt authentication with.

$hashedPassword

stringThe hashed password to attempt authentication against.

Response

boolean

Properties

passwordHandler

The password handler to validate the password against.

status

The last authentication status.

since

1.1.0

Type(s)

integer