User
class User implements UserInterface, EquatableInterface, AdvancedUserInterface
User is the user implementation used by the in-memory user provider.
This should not be used for anything else.
Methods
No description
No description
Returns the roles granted to the user.
Returns the password used to authenticate the user.
Returns the salt that was originally used to encode the password.
Returns the username used to authenticate the user.
Checks whether the user's account has expired.
Checks whether the user is locked.
Checks whether the user's credentials (password) has expired.
Checks whether the user is enabled.
Removes sensitive data from the user.
The equality comparison should neither be done by referential equality nor by comparing identities (i.e. getId() === getId()).
Details
__construct(string|null $username, string|null $password, array $roles = array(), bool $enabled = true, bool $userNonExpired = true, bool $credentialsNonExpired = true, bool $userNonLocked = true)
(Role|string)[]
getRoles()
Returns the roles granted to the user.
public function getRoles() { return array('ROLE_USER'); }
Alternatively, the roles might be stored on a roles
property,
and populated in any number of different ways when the user object
is created.
string
getPassword()
Returns the password used to authenticate the user.
This should be the encoded password. On authentication, a plain-text password will be salted, encoded, and then compared to this value.
string|null
getSalt()
Returns the salt that was originally used to encode the password.
This can return null if the password was not encoded using a salt.
bool
isAccountNonExpired()
Checks whether the user's account has expired.
Internally, if this method returns false, the authentication system will throw an AccountExpiredException and prevent login.
bool
isAccountNonLocked()
Checks whether the user is locked.
Internally, if this method returns false, the authentication system will throw a LockedException and prevent login.
bool
isCredentialsNonExpired()
Checks whether the user's credentials (password) has expired.
Internally, if this method returns false, the authentication system will throw a CredentialsExpiredException and prevent login.
bool
isEnabled()
Checks whether the user is enabled.
Internally, if this method returns false, the authentication system will throw a DisabledException and prevent login.
eraseCredentials()
Removes sensitive data from the user.
This is important if, at any given point, sensitive information like the plain-text password is stored on this object.
bool
isEqualTo(UserInterface $user)
The equality comparison should neither be done by referential equality nor by comparing identities (i.e. getId() === getId()).
However, you do not need to compare every attribute, but only those that are relevant for assessing whether re-authentication is required.