LdapUserProvider

__construct(LdapInterface $ldap, string $baseDn, string $searchDn = null, string $searchPassword = null, array $defaultRoles = array(), string|null $uidKey = 'sAMAccountName', string $filter = '({uid_key}={username})', string $passwordAttribute = null)

Parameters

LdapInterface	$ldap
string	$baseDn
string	$searchDn
string	$searchPassword
array	$defaultRoles
string|null	$uidKey
string	$filter
string	$passwordAttribute

UserInterface loadUserByUsername(string $username)

Loads the user for the given username.

This method must throw UsernameNotFoundException if the user is not found.

Parameters

string

$username

The username

Return Value

UserInterface

Exceptions

UsernameNotFoundException

if the user is not found

UserInterface refreshUser(UserInterface $user)

Refreshes the user.

It is up to the implementation to decide if the user data should be totally reloaded (e.g. from the database), or if the UserInterface object can just be merged into some internal array of users / identity map.

Parameters

UserInterface

$user

Return Value

UserInterface

Exceptions

UnsupportedUserException	if the user is not supported
UsernameNotFoundException	if the user is not found

bool supportsClass(string $class)

Whether this provider supports the given user class.

Parameters

string

$class

Return Value

bool

protected User loadUser(string $username, Entry $entry)

Loads a user from an LDAP entry.

Parameters

string	$username
Entry	$entry

Return Value

User