Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Authentication\AuthenticationProviderInterface.
6	*/
7
8	namespace Drupal\Core\Authentication;
9
10	use Symfony\Component\HttpFoundation\Request;
11
12	/**
13	* Interface for authentication providers.
14	*/
15	interface AuthenticationProviderInterface {
16
17	/**
18	* Checks whether suitable authentication credentials are on the request.
19	*
20	* @param \Symfony\Component\HttpFoundation\Request $request
21	* The request object.
22	*
23	* @return bool
24	* TRUE if authentication credentials suitable for this provider are on the
25	* request, FALSE otherwise.
26	*/
27	public function applies(Request $request);
28
29	/**
30	* Authenticates the user.
31	*
32	* @param \Symfony\Component\HttpFoundation\Request\|NULL $request
33	* The request object.
34	*
35	* @return \Drupal\Core\Session\AccountInterface\|NULL
36	* AccountInterface - in case of a successful authentication.
37	* NULL - in case where authentication failed.
38	*/
39	public function authenticate(Request $request);
40
41	}