interface AuthenticationProviderInterface in Zircon Profile 8

Interface for authentication providers.

Hierarchy

• interface \Drupal\Core\Authentication\AuthenticationProviderInterface

6 files declare their use of AuthenticationProviderInterface

Auth.php in core/modules/locale/tests/modules/early_translation_test/src/Auth.php

Contains \Drupal\early_translation_test\Auth.

AuthenticationCollectorTest.php in core/tests/Drupal/Tests/Core/Authentication/AuthenticationCollectorTest.php

Contains \Drupal\Tests\Core\Authentication\AuthenticationCollectorTest.

AuthenticationManagerTest.php in core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php

Contains \Drupal\Tests\Core\Authentication\AuthenticationManagerTest.

AuthenticationSubscriber.php in core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php

Contains \Drupal\Core\EventSubscriber\AuthenticationSubscriber.

BasicAuth.php in core/modules/basic_auth/src/Authentication/Provider/BasicAuth.php

Contains \Drupal\basic_auth\Authentication\Provider\BasicAuth.

... See full list

File

core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php, line 15

Contains \Drupal\Core\Authentication\AuthenticationProviderInterface.

Namespace

Drupal\Core\Authentication

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);

}

Members

Name	Modifiers	Type	Description	Overrides
AuthenticationProviderInterface::applies	public	function	Checks whether suitable authentication credentials are on the request.	5
AuthenticationProviderInterface::authenticate	public	function	Authenticates the user.	5