AuthService
in package
implements
AuthServiceInterface
Class AuthService
Tags
Interfaces, Classes and Traits
- AuthServiceInterface
- Interface AuthServiceInterface
Table of Contents
- $customerReadService : CustomerReadService
- $settings : AuthSettingsInterface
- __construct() : mixed
- Authentication constructor.
- authUser() : bool
- Authenticates a user by its email and password stored in the given AuthCredentialsInterface object.
- getHash() : string
- Returns a hash of the given password.
- getRehashedPassword() : string
- Returns a new hash of the given password.
- verify() : bool
- Verifies a password by its hash.
Properties
$customerReadService
protected
CustomerReadService
$customerReadService
$settings
protected
AuthSettingsInterface
$settings
Methods
__construct()
Authentication constructor.
public
__construct(AuthSettingsInterface $settings, CustomerReadService $customerReadService) : mixed
Parameters
- $settings : AuthSettingsInterface
- $customerReadService : CustomerReadService
Return values
mixed —authUser()
Authenticates a user by its email and password stored in the given AuthCredentialsInterface object.
public
authUser(AuthCredentialsInterface $authCredentials) : bool
Parameters
- $authCredentials : AuthCredentialsInterface
-
.
Return values
bool —Returns the result of the authentication.
getHash()
Returns a hash of the given password.
public
getHash(StringType $password) : string
Parameters
- $password : StringType
Return values
string —Password Hash.
getRehashedPassword()
Returns a new hash of the given password.
public
getRehashedPassword(StringType $password, NonEmptyStringType $hash) : string
It will only differ from the given hash if the given hash is valid but does match to the current auth strategy.
Parameters
- $password : StringType
- $hash : NonEmptyStringType
Return values
string —Rehashed password.
verify()
Verifies a password by its hash.
public
verify(StringType $password, NonEmptyStringType $hash) : bool
Parameters
- $password : StringType
-
Password.
- $hash : NonEmptyStringType
-
Hash.
Return values
bool —Returns the result of the verification.