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 = null, string $filter = null, string $passwordAttribute = null)

No description

loadUserByUsername(string $username)

Loads the user for the given username.

refreshUser(UserInterface $user)

Refreshes the user.

bool
supportsClass(string $class)

Whether this provider supports the given user class.

Details

at line line 38
__construct(LdapInterface $ldap, string $baseDn, string $searchDn = null, string $searchPassword = null, array $defaultRoles = array(), string $uidKey = null, string $filter = null, string $passwordAttribute = null)

Parameters

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

at line line 61
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

at line line 98
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

at line line 110
bool supportsClass(string $class)

Whether this provider supports the given user class.

Parameters

string $class

Return Value

bool