LdapUserProvider

class LdapUserProvider implements UserProviderInterface

LdapUserProvider is a simple user provider on top of ldap.

Methods

	__construct(LdapInterface $ldap, string $baseDn, string $searchDn = null, string $searchPassword = null, array $defaultRoles = array(), string $uidKey = 'sAMAccountName', string $filter = '({uid_key}={username})', string $passwordAttribute = null)
UserInterface	loadUserByUsername(string $username) Loads the user for the given username.
UserInterface	refreshUser(UserInterface $user) Refreshes the user for the account interface.
bool	supportsClass(string $class) Whether this provider supports the given user class.

Details

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

Parameters

LdapInterface	$ldap
string	$baseDn
string	$searchDn
string	$searchPassword
array	$defaultRoles
string	$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 for the account interface.

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.