AdvancedUserInterface
interface AdvancedUserInterface implements UserInterface
Добавляет дополнительные возможности к классу пользователя, связанные с флагами состояния учетной записи.
Этот интерфейс можно реализовать вместо 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.
http://api.symfony.com/2.7/Symfony/Component/Security/Core/User/AdvancedUserInterface.html