AbstractUsernamePasswordAuthenticationStrategy

Implements AuthenticationStrategyInterface

Abstract AuthenticationStrategy for username/password based authentication

abstract
since

1.1.0

package

Joomla Framework

Methods

__construct

Constructor.

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

1.2.0

Arguments

passwordHandler

\Joomla\Authentication\Password\HandlerInterfaceThe password handler.

Response

mixed

doAuthenticate

Attempt to authenticate the username and password pair.

doAuthenticate(string username, string password) : string|bool
since

1.1.0

Arguments

username

stringThe username to authenticate.

password

stringThe password to attempt authentication with.

Response

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

getHashedPassword

Retrieve the hashed password for the specified user.

getHashedPassword(string username) : string|bool
abstract
since

1.1.0

Arguments

username

stringUsername to lookup.

Response

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

getResult

Get the status of the last authentication attempt.

getResult() : int
since

1.1.0

Response

intAuthentication class constant result.

verifyPassword

Attempt to verify the username and password pair.

verifyPassword(string username, string password, string hashedPassword) : bool
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

bool

Properties

passwordHandler

The password handler to validate the password against.

since

1.2.0

Type(s)

\Joomla\Authentication\Password\HandlerInterface

status

The last authentication status.

since

1.1.0

Type(s)

int