UserProviderInterface
интерфейс UserProviderInterface
Представляет класс, загружающий объекты UserInterface из некоторого источника для системы аутентификации.
В типичной конфигурации аутентификации данные пользователя (т.е. некоторый уникальный идентификатор пользователя) поступают в систему (через форму входа или любым другим методом). Конфигурированный поставщик пользователей для этого метода аутентификации запрошен загрузить объект UserInterface для данного имени пользователя (через loadUserByUsername), чтобы продолжить процесс.
Внутренне поставщик пользователей может загружать пользователей из любого источника (базы данных, конфигурации, веб-сервиса). Это полностью независимо от того, как передается информация об аутентификации или как выглядит объект UserInterface.
Методы
| UserInterface | loadUserByUsername(string $username) Загружает пользователя по данному имени пользователя. | |
| UserInterface | refreshUser(UserInterface $user) Обновляет данные пользователя. | |
| bool | supportsClass(string $class) Определяет, поддерживает ли данный поставщик указанный класс пользователя. |
Подробности
UserInterface loadUserByUsername(string $username)
Загружает пользователя по данному имени пользователя.
Этот метод должен вызывать исключение UsernameNotFoundException, если пользователь не найден.
Параметры
| string | $username | Имя пользователя |
Возвращаемое значение
| UserInterface |
Исключения
| UsernameNotFoundException | если пользователь не найден |
См. также
| UsernameNotFoundException |
UserInterface refreshUser(UserInterface $user)
Обновляет данные пользователя.
Реализация должна решить, нужно ли полностью перезагружать данные пользователя (например, из базы данных), или объект UserInterface можно просто объединить с внутренней коллекцией пользователей/отображением.
Параметры
| UserInterface | $user |
Возвращаемое значение
| UserInterface |
Исключения
| UnsupportedUserException | если пользователь не поддерживается |
bool supportsClass(string $class)
Определяет, поддерживает ли данный поставщик указанный класс пользователя.
Параметры
| string | $class |
Возвращаемое значение
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Security/Core/User/UserProviderInterface.html
