Spec-Zone.ru › Symfony 4.1

LdapUserProvider

class LdapUserProvider implements UserProviderInterface

LdapUserProvider — это простой провайдер пользователей, работающий поверх ldap.

Методы

__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)
UserInterface loadUserByUsername(string $username)

Загружает пользователя по заданному имени пользователя.

UserInterface refreshUser(UserInterface $user)

Обновляет данные пользователя.

bool supportsClass(string $class)

Определяет, поддерживает ли данный провайдер заданный класс пользователя.

User loadUser(string $username, Entry $entry)

Загружает пользователя из записи LDAP.

Детали

__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)

Параметры

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

UserInterface loadUserByUsername(string $username)

Загружает пользователя по заданному имени пользователя.

Этот метод должен выбрасывать UsernameNotFoundException, если пользователь не найден.

Параметры

string $username Имя пользователя

Возвращаемое значение

UserInterface

Исключения

UsernameNotFoundException если пользователь не найден

UserInterface refreshUser(UserInterface $user)

Обновляет данные пользователя.

Реализация должна сама решать, нужно ли полностью перезагружать данные пользователя (например, из базы данных), или объект UserInterface можно просто объединить с внутренним массивом пользователей/отображением.

Параметры

UserInterface $user

Возвращаемое значение

UserInterface

Исключения

UnsupportedUserException если пользователь не поддерживается
UsernameNotFoundException если пользователь не найден

bool supportsClass(string $class)

Определяет, поддерживает ли данный провайдер заданный класс пользователя.

Параметры

string $class

Возвращаемое значение

bool

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

Загружает пользователя из записи LDAP.

Параметры

string $username
Entry $entry

Возвращаемое значение

User

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/User/LdapUserProvider.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API