Mercurial > hg > isophonics-drupal-site
annotate core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\Core\Authentication; |
Chris@0 | 4 |
Chris@0 | 5 use Symfony\Component\HttpFoundation\Request; |
Chris@0 | 6 |
Chris@0 | 7 /** |
Chris@0 | 8 * Interface for authentication providers. |
Chris@0 | 9 */ |
Chris@0 | 10 interface AuthenticationProviderInterface { |
Chris@0 | 11 |
Chris@0 | 12 /** |
Chris@0 | 13 * Checks whether suitable authentication credentials are on the request. |
Chris@0 | 14 * |
Chris@0 | 15 * @param \Symfony\Component\HttpFoundation\Request $request |
Chris@0 | 16 * The request object. |
Chris@0 | 17 * |
Chris@0 | 18 * @return bool |
Chris@0 | 19 * TRUE if authentication credentials suitable for this provider are on the |
Chris@0 | 20 * request, FALSE otherwise. |
Chris@0 | 21 */ |
Chris@0 | 22 public function applies(Request $request); |
Chris@0 | 23 |
Chris@0 | 24 /** |
Chris@0 | 25 * Authenticates the user. |
Chris@0 | 26 * |
Chris@0 | 27 * @param \Symfony\Component\HttpFoundation\Request|null $request |
Chris@0 | 28 * The request object. |
Chris@0 | 29 * |
Chris@0 | 30 * @return \Drupal\Core\Session\AccountInterface|null |
Chris@0 | 31 * AccountInterface - in case of a successful authentication. |
Chris@0 | 32 * NULL - in case where authentication failed. |
Chris@0 | 33 */ |
Chris@0 | 34 public function authenticate(Request $request); |
Chris@0 | 35 |
Chris@0 | 36 } |