Interface AdvancedUserInterface

Adds extra features to a user class related to account status flags.

This interface can be implemented in place of UserInterface if you'd like the authentication system to consider different account status flags during authentication. If any of the methods in this interface return false, authentication will fail.

If you need to perform custom logic for any of these situations, then you will need to register an exception listener and watch for the specific exception instances thrown in each case. All exceptions are a subclass of AccountStatusException

Symfony\Component\Security\Core\User\AdvancedUserInterface implements Symfony\Component\Security\Core\User\UserInterface

Direct known implementers

Symfony\Component\Security\Core\User\User

Namespace: Symfony\Component\Security\Core\User
Author: Fabien Potencier <fabien@symfony.com>
See: Symfony\Component\Security\Core\User\UserInterface
See: AccountStatusException
Located at AdvancedUserInterface.php

Methods summary
`public boolean`	# `isAccountNonExpired( )` Checks whether the user's account has expired. Checks whether the user's account has expired. Internally, if this method returns false, the authentication system will throw an AccountExpiredException and prevent login. Returns `boolean` true if the user's account is non expired, false otherwise See AccountExpiredException
`public boolean`	# `isAccountNonLocked( )` Checks whether the user is locked. Checks whether the user is locked. Internally, if this method returns false, the authentication system will throw a LockedException and prevent login. Returns `boolean` true if the user is not locked, false otherwise See LockedException
`public boolean`	# `isCredentialsNonExpired( )` Checks whether the user's credentials (password) has expired. 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. Returns `boolean` true if the user's credentials are non expired, false otherwise See CredentialsExpiredException
`public boolean`	# `isEnabled( )` Checks whether the user is enabled. Checks whether the user is enabled. Internally, if this method returns false, the authentication system will throw a DisabledException and prevent login. Returns `boolean` true if the user is enabled, false otherwise See DisabledException

Methods inherited from Symfony\Component\Security\Core\User\UserInterface
`eraseCredentials(), getPassword(), getRoles(), getSalt(), getUsername()`

Namespaces

Classes

Interfaces

Interface AdvancedUserInterface

Direct known implementers

Returns

See

Returns

See

Returns

See

Returns

See