LocalStrategy

Extends AbstractUsernamePasswordAuthenticationStrategy

Joomla Framework Local Strategy Authentication class

since

1.0

package

Joomla Framework

Methods

__construct

Constructor.

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

1.2.0

Arguments

passwordHandler

\Joomla\Authentication\Password\HandlerInterfaceThe password handler.

Response

mixed

authenticate

Attempt to authenticate the username and password pair.

authenticate() : string|bool
since

1.0

Response

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

doAuthenticate

Attempt to authenticate the username and password pair.

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

credentialStore

The credential store.

since

1.0

Type(s)

array

input

The Input object

since

1.0

Type(s)

\Joomla\Input\Input

passwordHandler

The password handler to validate the password against.

inherited
since

1.2.0

Type(s)

\Joomla\Authentication\Password\HandlerInterface

status

The last authentication status.

inherited
since

1.1.0

Type(s)

int