summaryrefslogtreecommitdiffstats
path: root/Core/User/UserCheckerInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'Core/User/UserCheckerInterface.php')
-rw-r--r--Core/User/UserCheckerInterface.php11
1 files changed, 9 insertions, 2 deletions
diff --git a/Core/User/UserCheckerInterface.php b/Core/User/UserCheckerInterface.php
index 3dd8d51..62ea9f0 100644
--- a/Core/User/UserCheckerInterface.php
+++ b/Core/User/UserCheckerInterface.php
@@ -11,10 +11,13 @@
namespace Symfony\Component\Security\Core\User;
+use Symfony\Component\Security\Core\Exception\AccountStatusException;
+
/**
- * UserCheckerInterface checks user account when authentication occurs.
+ * Implement to throw AccountStatusException during the authentication process.
*
- * This should not be used to make authentication decisions.
+ * Can be used when you want to check the account status, e.g when the account is
+ * disabled or blocked. This should not be used to make authentication decisions.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
@@ -24,6 +27,8 @@ interface UserCheckerInterface
* Checks the user account before authentication.
*
* @param UserInterface $user a UserInterface instance
+ *
+ * @throws AccountStatusException
*/
public function checkPreAuth(UserInterface $user);
@@ -31,6 +36,8 @@ interface UserCheckerInterface
* Checks the user account after authentication.
*
* @param UserInterface $user a UserInterface instance
+ *
+ * @throws AccountStatusException
*/
public function checkPostAuth(UserInterface $user);
}