This commit is contained in:
Fabien Potencier 2012-01-09 12:13:49 +01:00
parent e8d1bd2902
commit 2f0afb2b5a
3 changed files with 29 additions and 14 deletions

View File

@ -11,6 +11,12 @@
namespace Symfony\Component\Security\Core\User;
use Symfony\Component\Security\Core\Exception\AccountStatusException;
use Symfony\Component\Security\Core\Exception\AccountExpiredException;
use Symfony\Component\Security\Core\Exception\LockedException;
use Symfony\Component\Security\Core\Exception\CredentialsExpiredException;
use Symfony\Component\Security\Core\Exception\DisabledException;
/**
* Adds extra features to a user class related to account status flags.
*
@ -25,7 +31,8 @@ namespace Symfony\Component\Security\Core\User;
* of AccountStatusException
*
* @see UserInterface
* @see Symfony\Component\Security\Core\Exception\AccountStatusException
* @see AccountStatusException
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface AdvancedUserInterface extends UserInterface
@ -36,9 +43,9 @@ interface AdvancedUserInterface extends UserInterface
* Internally, if this method returns false, the authentication system
* will throw an AccountExpiredException and prevent login.
*
* @see Symfony\Component\Security\Core\Exception\AccountExpiredException
*
* @return Boolean true if the user's account is non expired, false otherwise
*
* @see AccountExpiredException
*/
function isAccountNonExpired();
@ -48,9 +55,9 @@ interface AdvancedUserInterface extends UserInterface
* Internally, if this method returns false, the authentication system
* will throw a LockedException and prevent login.
*
* @see Symfony\Component\Security\Core\Exception\LockedException
*
* @return Boolean true if the user is not locked, false otherwise
*
* @see LockedException
*/
function isAccountNonLocked();
@ -60,9 +67,9 @@ interface AdvancedUserInterface extends UserInterface
* Internally, if this method returns false, the authentication system
* will throw a CredentialsExpiredException and prevent login.
*
* @see Symfony\Component\Security\Core\Exception\CredentialsExpiredException
*
* @return Boolean true if the user's credentials are non expired, false otherwise
*
* @see CredentialsExpiredException
*/
function isCredentialsNonExpired();
@ -72,9 +79,9 @@ interface AdvancedUserInterface extends UserInterface
* Internally, if this method returns false, the authentication system
* will throw a DisabledException and prevent login.
*
* @see Symfony\Component\Security\Core\Exception\DisabledException
*
* @return Boolean true if the user is enabled, false otherwise
*
* @see DisabledException
*/
function isEnabled();
}

View File

@ -26,6 +26,7 @@ namespace Symfony\Component\Security\Core\User;
*
* @see UserProviderInterface
* @see AdvancedUserInterface
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface UserInterface

View File

@ -11,6 +11,9 @@
namespace Symfony\Component\Security\Core\User;
use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
/**
* Represents a class that loads UserInterface objects from some source for the authentication system.
*
@ -24,7 +27,8 @@ namespace Symfony\Component\Security\Core\User;
* configuration, web service). This is totally independent of how the authentication
* information is submitted or what the UserInterface object looks like.
*
* @see Symfony\Component\Security\Core\User\UserInterface
* @see UserInterface
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface UserProviderInterface
@ -35,11 +39,14 @@ interface UserProviderInterface
* This method must throw UsernameNotFoundException if the user is not
* found.
*
* @see UsernameNotFoundException
* @throws Symfony\Component\Security\Core\Exception\UsernameNotFoundException if the user is not found
* @param string $username The username
*
* @return UserInterface
*
* @see UsernameNotFoundException
*
* @throws UsernameNotFoundException if the user is not found
*
*/
function loadUserByUsername($username);
@ -50,11 +57,11 @@ interface UserProviderInterface
* totally reloaded (e.g. from the database), or if the UserInterface
* object can just be merged into some internal array of users / identity
* map.
*
* @throws Symfony\Component\Security\Core\Exception\UnsupportedUserException if the account is not supported
* @param UserInterface $user
*
* @return UserInterface
*
* @throws UnsupportedUserException if the account is not supported
*/
function refreshUser(UserInterface $user);