Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AbstractUsernamePasswordAuthenticationStrategy
+ Graphe d'héritage de AbstractUsernamePasswordAuthenticationStrategy:

Fonctions membres publiques

 __construct (?HandlerInterface $passwordHandler=null)
 
 getResult ()
 
- Fonctions membres publiques hérités de AuthenticationStrategyInterface
 authenticate ()
 

Fonctions membres protégées

 doAuthenticate ($username, $password)
 
 getHashedPassword ($username)
 
 verifyPassword ($username, $password, $hashedPassword)
 

Attributs protégés

 $passwordHandler
 
 $status
 

Description détaillée

Abstract AuthenticationStrategy for username/password based authentication

Depuis
1.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( ?HandlerInterface  $passwordHandler = null)

Constructor.

Paramètres
HandlerInterface$passwordHandlerThe password handler.
Depuis
1.2.0

Références AbstractUsernamePasswordAuthenticationStrategy\$passwordHandler.

Documentation des fonctions membres

◆ doAuthenticate()

doAuthenticate (   $username,
  $password 
)
protected

Attempt to authenticate the username and password pair.

Paramètres
string$usernameThe username to authenticate.
string$passwordThe password to attempt authentication with.
Renvoie
string|boolean A string containing a username if authentication is successful, false otherwise.
Depuis
1.1.0

Références $password, AbstractUsernamePasswordAuthenticationStrategy\getHashedPassword(), Authentication\INVALID_CREDENTIALS, Authentication\NO_SUCH_USER, Authentication\SUCCESS, et AbstractUsernamePasswordAuthenticationStrategy\verifyPassword().

Référencé par LocalStrategy\authenticate(), et DatabaseStrategy\authenticate().

◆ getHashedPassword()

getHashedPassword (   $username)
abstractprotected

Retrieve the hashed password for the specified user.

Paramètres
string$usernameUsername to lookup.
Renvoie
string|boolean Hashed password on success or boolean false on failure.
Depuis
1.1.0

Référencé par AbstractUsernamePasswordAuthenticationStrategy\doAuthenticate().

◆ getResult()

getResult ( )

Get the status of the last authentication attempt.

Renvoie
integer Authentication class constant result.
Depuis
1.1.0

Implémente AuthenticationStrategyInterface.

Références AbstractUsernamePasswordAuthenticationStrategy\$status.

◆ verifyPassword()

verifyPassword (   $username,
  $password,
  $hashedPassword 
)
protected

Attempt to verify the username and password pair.

Paramètres
string$usernameThe username to authenticate.
string$passwordThe password to attempt authentication with.
string$hashedPasswordThe hashed password to attempt authentication against.
Renvoie
boolean
Depuis
1.1.0

Références $password.

Référencé par AbstractUsernamePasswordAuthenticationStrategy\doAuthenticate().

Documentation des champs

◆ $passwordHandler

◆ $status


La documentation de cette classe a été générée à partir du fichier suivant :