1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Authentication
  7. \
  8. AuthenticationProviderInterface

AuthenticationProviderInterface

interface AuthenticationProviderInterface (View source)

Interface for authentication providers.

Methods

bool
applies(Request $request)

Checks whether suitable authentication credentials are on the request.

AccountInterface|null
authenticate(Request $request)

Authenticates the user.

Details

at line 22
bool applies(Request $request)

Checks whether suitable authentication credentials are on the request.

Parameters

Request $request

The request object.

Return Value

bool

TRUE if authentication credentials suitable for this provider are on the request, FALSE otherwise.

at line 34
AccountInterface|null authenticate(Request $request)

Authenticates the user.

Parameters

Request $request

The request object.

Return Value

AccountInterface|null

AccountInterface - in case of a successful authentication. NULL - in case where authentication failed.