annotate core/modules/user/src/UserAuthInterface.php @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1
author Chris Cannam
date Thu, 09 May 2019 15:34:47 +0100
parents c75dbcec494b
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\user;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * An interface for validating user authentication credentials.
Chris@0 7 */
Chris@0 8 interface UserAuthInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Validates user authentication credentials.
Chris@0 12 *
Chris@0 13 * @param string $username
Chris@0 14 * The user name to authenticate.
Chris@0 15 * @param string $password
Chris@0 16 * A plain-text password, such as trimmed text from form values.
Chris@0 17 * @return int|bool
Chris@0 18 * The user's uid on success, or FALSE on failure to authenticate.
Chris@0 19 */
Chris@0 20 public function authenticate($username, $password);
Chris@0 21
Chris@0 22 }