ExtraInvalidCredentials
in package
Provides additional messages if login failed.
Table of Contents
- getExtraMessage() : null|string
- Tries to get additional information why invalid credentials was returned. E.g. account is locked.
- findProviders() : array<string|int, ExtraInvalidCredentialsProvider>
- Returns a list of ExtraInvalidCredentialsProvider objects.
- getAttributeNames() : mixed
- Returns the attribute names for the LDAP search.
- getLdapData() : array<string|int, mixed>|null
- Reads the LDAP data.
- getMessageFromProviders() : null|string
- Returns the message from the providers.
- includeFiles() : mixed
- Includes all plugin files.
Methods
getExtraMessage()
Tries to get additional information why invalid credentials was returned. E.g. account is locked.
public
getExtraMessage(handle $ldap, string $userDn) : null|string
Parameters
- $ldap : handle
-
LDAP object to connect for getting extra data
- $userDn : string
-
failed DN
Return values
null|string —extra message
findProviders()
Returns a list of ExtraInvalidCredentialsProvider objects.
protected
findProviders() : array<string|int, ExtraInvalidCredentialsProvider>
Return values
array<string|int, ExtraInvalidCredentialsProvider> —providers
getAttributeNames()
Returns the attribute names for the LDAP search.
protected
getAttributeNames(array<string|int, ExtraInvalidCredentialsProvider> $providers) : mixed
Parameters
- $providers : array<string|int, ExtraInvalidCredentialsProvider>
Return values
mixed —getLdapData()
Reads the LDAP data.
protected
getLdapData(string $userDn, array<string|int, mixed> $attributes, handle $ldap) : array<string|int, mixed>|null
Parameters
- $userDn : string
-
user DN
- $attributes : array<string|int, mixed>
-
attribute names
- $ldap : handle
-
LDAP handle
Return values
array<string|int, mixed>|null —attribute values
getMessageFromProviders()
Returns the message from the providers.
protected
getMessageFromProviders(array<string|int, ExtraInvalidCredentialsProvider> $providers, array<string|int, mixed> $userData, handle $ldap) : null|string
Parameters
- $providers : array<string|int, ExtraInvalidCredentialsProvider>
-
providers
- $userData : array<string|int, mixed>
-
LDAP data
- $ldap : handle
-
LDAP handle
Return values
null|string —extra message
includeFiles()
Includes all plugin files.
protected
includeFiles() : mixed