Spec-Zone.ru › Symfony 4.1

InMemoryUserProvider

class InMemoryUserProvider implements UserProviderInterface

InMemoryUserProvider — это простой непостоянный поставщик пользователей.

Полезен для тестирования, демонстрации, прототипирования и для простых потребностей (например, бэкенд с единственным администратором).

Методы

__construct(array $users = array())

Массив пользователей — это хеш, где ключи — имена пользователей, а значения — массив атрибутов: 'password', 'enabled' и 'roles'.

createUser(UserInterface $user)

Добавляет нового пользователя в поставщик.

UserInterface loadUserByUsername(string $username)

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

UserInterface refreshUser(UserInterface $user)

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

bool supportsClass(string $class)

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

Подробное описание

__construct(array $users = array())

Массив пользователей — это хеш, где ключи — имена пользователей, а значения — массив атрибутов: 'password', 'enabled' и 'roles'.

Параметры

array $users Массив пользователей

createUser(UserInterface $user)

Добавляет нового пользователя в поставщик.

Параметры

UserInterface $user

Исключения

LogicException

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

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

Spec-Zone.ru

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