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