www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/user/src/UserAuthInterface.php

   1 <?php
   2
   3 namespace Drupal\user;
   4
   5 /**
   6  * An interface for validating user authentication credentials.
   7  */
   8 interface UserAuthInterface {
   9
  10   /**
  11    * Validates user authentication credentials.
  12    *
  13    * @param string $username
  14    *   The user name to authenticate.
  15    * @param string $password
  16    *   A plain-text password, such as trimmed text from form values.
  17    * @return int|bool
  18    *   The user's uid on success, or FALSE on failure to authenticate.
  19    */
  20   public function authenticate($username, $password);
  21
  22 }