interface UserAuthInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/user/src/UserAuthInterface.php \Drupal\user\UserAuthInterface
An interface for validating user authentication credentials.
Hierarchy
- interface \Drupal\user\UserAuthInterface
Expanded class hierarchy of UserAuthInterface
All classes that implement UserAuthInterface
2 files declare their use of UserAuthInterface
- BasicAuth.php in core/
modules/ basic_auth/ src/ Authentication/ Provider/ BasicAuth.php - Contains \Drupal\basic_auth\Authentication\Provider\BasicAuth.
- UserLoginForm.php in core/
modules/ user/ src/ Form/ UserLoginForm.php - Contains \Drupal\user\Form\UserLoginForm.
File
- core/
modules/ user/ src/ UserAuthInterface.php, line 13 - Contains \Drupal\user\UserAuthInterface.
Namespace
Drupal\userView source
interface UserAuthInterface {
/**
* Validates user authentication credentials.
*
* @param string $username
* The user name to authenticate.
* @param string $password
* A plain-text password, such as trimmed text from form values.
* @return int|bool
* The user's uid on success, or FALSE on failure to authenticate.
*/
public function authenticate($username, $password);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
UserAuthInterface:: |
public | function | Validates user authentication credentials. | 1 |