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

AuthenticationCollectorInterface

interface AuthenticationCollectorInterface (View source)

Interface for collectors of registered authentication providers.

Methods

addProvider(AuthenticationProviderInterface $provider, string $provider_id, int $priority = 0, bool $global = FALSE)

Adds a provider to the array of registered providers.

bool
isGlobal(string $provider_id)

Returns whether a provider is considered global.

AuthenticationProviderInterface|null
getProvider(string $provider_id)

Returns an authentication provider.

AuthenticationProviderInterface[]
getSortedProviders()

Returns the sorted array of authentication providers.

Details

at line 23
addProvider(AuthenticationProviderInterface $provider, string $provider_id, int $priority = 0, bool $global = FALSE)

Adds a provider to the array of registered providers.

Parameters

AuthenticationProviderInterface $provider

The provider object.
string $provider_id

Identifier of the provider.
int $priority

(optional) The provider's priority.
bool $global

(optional) TRUE if the provider is to be applied globally on all routes. Defaults to FALSE.

at line 36
bool isGlobal(string $provider_id)

Returns whether a provider is considered global.

Parameters

string $provider_id

The provider ID.

Return Value

bool

TRUE if the provider is global, FALSE otherwise.

See also

AuthenticationCollectorInterface::addProvider

at line 47
AuthenticationProviderInterface|null getProvider(string $provider_id)

Returns an authentication provider.

Parameters

string $provider_id

The provider ID.

Return Value

AuthenticationProviderInterface|null

The authentication provider which matches the ID.

at line 55
AuthenticationProviderInterface[] getSortedProviders()

Returns the sorted array of authentication providers.

Return Value

AuthenticationProviderInterface[]

An array of authentication provider objects.