class UserAuth in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/user/src/UserAuth.php \Drupal\user\UserAuth
Validates user authentication credentials.
Hierarchy
- class \Drupal\user\UserAuth implements UserAuthInterface
Expanded class hierarchy of UserAuth
1 file declares its use of UserAuth
- UserAuthTest.php in core/
modules/ user/ tests/ src/ Unit/ UserAuthTest.php - Contains \Drupal\Tests\user\Unit\UserAuthTest.
1 string reference to 'UserAuth'
- user.services.yml in core/
modules/ user/ user.services.yml - core/modules/user/user.services.yml
1 service uses UserAuth
- user.auth in core/
modules/ user/ user.services.yml - Drupal\user\UserAuth
File
- core/
modules/ user/ src/ UserAuth.php, line 16 - Contains \Drupal\user\UserAuth.
Namespace
Drupal\userView source
class UserAuth implements UserAuthInterface {
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* The password hashing service.
*
* @var \Drupal\Core\Password\PasswordInterface
*/
protected $passwordChecker;
/**
* Constructs a UserAuth object.
*
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager.
* @param \Drupal\Core\Password\PasswordInterface $password_checker
* The password service.
*/
public function __construct(EntityManagerInterface $entity_manager, PasswordInterface $password_checker) {
$this->entityManager = $entity_manager;
$this->passwordChecker = $password_checker;
}
/**
* {@inheritdoc}
*/
public function authenticate($username, $password) {
$uid = FALSE;
if (!empty($username) && strlen($password) > 0) {
$account_search = $this->entityManager
->getStorage('user')
->loadByProperties(array(
'name' => $username,
));
if ($account = reset($account_search)) {
if ($this->passwordChecker
->check($password, $account
->getPassword())) {
// Successful authentication.
$uid = $account
->id();
// Update user to new password scheme if needed.
if ($this->passwordChecker
->needsRehash($account
->getPassword())) {
$account
->setPassword($password);
$account
->save();
}
}
}
}
return $uid;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
UserAuth:: |
protected | property | The entity manager. | |
UserAuth:: |
protected | property | The password hashing service. | |
UserAuth:: |
public | function |
Validates user authentication credentials. Overrides UserAuthInterface:: |
|
UserAuth:: |
public | function | Constructs a UserAuth object. |