diff core/modules/user/src/UserAuthInterface.php @ 0:c75dbcec494b

Initial commit from drush-created site
author Chris Cannam
date Thu, 05 Jul 2018 14:24:15 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/modules/user/src/UserAuthInterface.php	Thu Jul 05 14:24:15 2018 +0000
@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\user;
+
+/**
+ * An interface for validating user authentication credentials.
+ */
+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);
+
+}