Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,36 @@ +<?php + +namespace Drupal\Core\Authentication; + +use Symfony\Component\HttpFoundation\Request; + +/** + * Interface for authentication providers. + */ +interface AuthenticationProviderInterface { + + /** + * Checks whether suitable authentication credentials are on the request. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * + * @return bool + * TRUE if authentication credentials suitable for this provider are on the + * request, FALSE otherwise. + */ + public function applies(Request $request); + + /** + * Authenticates the user. + * + * @param \Symfony\Component\HttpFoundation\Request|null $request + * The request object. + * + * @return \Drupal\Core\Session\AccountInterface|null + * AccountInterface - in case of a successful authentication. + * NULL - in case where authentication failed. + */ + public function authenticate(Request $request); + +}