AdvancedUserInterface
interface AdvancedUserInterface implements UserInterface
Добавляет дополнительные возможности к классу пользователя, связанные со флагами статуса аккаунта.
Этот интерфейс может быть реализован вместо UserInterface, если вы хотите, чтобы система аутентификации учитывала различные флаги статуса аккаунта во время аутентификации. Если любой из методов в этом интерфейсе возвращает false, аутентификация завершится неудачей.
Если вам необходимо выполнить пользовательскую логику для любой из этих ситуаций, вам потребуется зарегистрировать обработчик исключений и следить за конкретными экземплярами исключений, которые выбрасываются в каждом случае. Все исключения являются подклассом AccountStatusException
Методы
| Роль[] | getRoles() Возвращает роли, предоставленные пользователю. | from UserInterface |
| строка | getPassword() Возвращает пароль, используемый для аутентификации пользователя. | from UserInterface |
| строка|null | getSalt() Возвращает соль, которая была изначально использована для кодирования пароля. | from UserInterface |
| строка | getUsername() Возвращает имя пользователя, используемое для аутентификации пользователя. | from UserInterface |
| eraseCredentials() Удаляет конфиденциальные данные пользователя. | from UserInterface | |
| bool | isAccountNonExpired() Проверяет, истек ли срок действия учетной записи пользователя. | |
| bool | isAccountNonLocked() Проверяет, заблокирован ли пользователь. | |
| bool | isCredentialsNonExpired() Проверяет, истек ли срок действия учетных данных (пароля) пользователя. | |
| bool | isEnabled() Проверяет, активирован ли пользователь. |
Подробности
Роль[] getRoles()
Возвращает роли, предоставленные пользователю.
public function getRoles()
{
return array('ROLE_USER');
}
В качестве альтернативы, роли могут храниться в свойстве roles, и заполняться различными способами при создании объекта пользователя.
Возвращаемое значение
| Роль[] | Роли пользователя |
строка getPassword()
Возвращает пароль, используемый для аутентификации пользователя.
Это должен быть закодированный пароль. Во время аутентификации обычный пароль будет засален, закодирован и затем сравнен с этим значением.
Возвращаемое значение
| строка | Пароль |
строка|null getSalt()
Возвращает соль, которая была изначально использована для кодирования пароля.
Это может вернуть null, если пароль не был закодирован с использованием соли.
Возвращаемое значение
| строка|null | Соль |
строка getUsername()
Возвращает имя пользователя, используемое для аутентификации пользователя.
Возвращаемое значение
| строка | Имя пользователя |
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.
http://api.symfony.com/2.8/Symfony/Component/Security/Core/User/AdvancedUserInterface.html
