AdvancedUserInterface deprecated
interface AdvancedUserInterface implements UserInterface
deprecated
Добавляет дополнительные возможности к классу пользователя, связанные с флагами состояния учетной записи.
Этот интерфейс можно реализовать вместо UserInterface, если вы хотите, чтобы система аутентификации учитывала разные флаги состояния учетной записи во время аутентификации. Если любой из методов в этом интерфейсе возвращает false, аутентификация завершится неудачей.
Если вам нужно выполнить пользовательскую логику для любой из этих ситуаций, вам необходимо зарегистрировать обработчик исключений и следить за конкретными экземплярами исключений, выбрасываемыми в каждом случае. Все исключения являются подклассом AccountStatusException
Методы
| (Role|string)[] | getRoles() Возвращает роли, предоставленные пользователю. | from UserInterface |
| string | getPassword() Возвращает пароль, используемый для аутентификации пользователя. | from UserInterface |
| string|null | getSalt() Возвращает соль, которая изначально использовалась для кодирования пароля. | from UserInterface |
| string | getUsername() Возвращает имя пользователя, используемое для аутентификации пользователя. | from UserInterface |
| eraseCredentials() Удаляет конфиденциальные данные пользователя. | from UserInterface | |
| bool | isAccountNonExpired() Проверяет, истек ли срок действия учетной записи пользователя. | |
| bool | isAccountNonLocked() Проверяет, заблокирован ли пользователь. | |
| bool | isCredentialsNonExpired() Проверяет, истек ли срок действия учетных данных (пароля) пользователя. | |
| bool | isEnabled() Проверяет, активирован ли пользователь. |
Подробности
(Role|string)[] getRoles()
Возвращает роли, предоставленные пользователю.
public function getRoles() { return array('ROLE_USER'); }
В качестве альтернативы, роли могут храниться в свойстве roles, и заполняться любым количеством различных способов при создании объекта пользователя.
Возвращаемое значение
| (Role|string)[] | Роли пользователя |
string getPassword()
Возвращает пароль, используемый для аутентификации пользователя.
Это должен быть закодированный пароль. При аутентификации простой текст пароля будет засолен, закодирован и затем сравнен с этим значением.
Возвращаемое значение
| string | Пароль |
string|null getSalt()
Возвращает соль, которая изначально использовалась для кодирования пароля.
Это может вернуть null, если пароль не был закодирован с использованием соли.
Возвращаемое значение
| string|null | Соль |
string getUsername()
Возвращает имя пользователя, используемое для аутентификации пользователя.
Возвращаемое значение
| string | Имя пользователя |
eraseCredentials()
Удаляет конфиденциальные данные пользователя.
Это важно, если в любой момент конфиденциальная информация, такая как пароль в простом тексте, хранится в этом объекте.
bool isAccountNonExpired()
Проверяет, истек ли срок действия учетной записи пользователя.
Внутренне, если этот метод возвращает false, система аутентификации выбросит AccountExpiredException и предотвратит вход в систему.
Возвращаемое значение
| bool | true, если срок действия учетной записи не истек, в противном случае false |
См. также
| AccountExpiredException |
bool isAccountNonLocked()
Проверяет, заблокирован ли пользователь.
Внутренне, если этот метод возвращает false, система аутентификации выбросит LockedException и предотвратит вход в систему.
Возвращаемое значение
| bool | true, если пользователь не заблокирован, в противном случае false |
См. также
| LockedException |
bool isCredentialsNonExpired()
Проверяет, истек ли срок действия учетных данных (пароля) пользователя.
Внутренне, если этот метод возвращает false, система аутентификации выбросит CredentialsExpiredException и предотвратит вход в систему.
Возвращаемое значение
| bool | true, если срок действия учетных данных не истек, в противном случае false |
См. также
| CredentialsExpiredException |
bool isEnabled()
Проверяет, активирован ли пользователь.
Внутренне, если этот метод возвращает false, система аутентификации выбросит DisabledException и предотвратит вход в систему.
Возвращаемое значение
| bool | true, если пользователь активирован, в противном случае false |
См. также
| DisabledException |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Core/User/AdvancedUserInterface.html
