improve dx and document auth exception

symfony · Apr 1, 2021 · b9b14e0 · b9b14e0
1 parent a4b3d12
commit b9b14e0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/Authenticator/Passport/Badge/UserBadge.php b/Authenticator/Passport/Badge/UserBadge.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Authenticator\Passport\Badge;
 
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Http\EventListener\UserProviderListener;
@@ -55,6 +56,9 @@ public function getUserIdentifier(): string
         return $this->userIdentifier;
     }
 
+    /**
+     * @throws AuthenticationException when the user cannot be found
+     */
     public function getUser(): UserInterface
     {
         if (null === $this->user) {

diff --git a/Authenticator/Passport/Passport.php b/Authenticator/Passport/Passport.php
@@ -55,6 +55,9 @@ public function __construct($userBadge, CredentialsInterface $credentials, array
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getUser(): UserInterface
     {
         if (null === $this->user) {

diff --git a/Authenticator/Passport/UserPassportInterface.php b/Authenticator/Passport/UserPassportInterface.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Authenticator\Passport;
 
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
@@ -22,5 +23,8 @@
  */
 interface UserPassportInterface extends PassportInterface
 {
+    /**
+     * @throws AuthenticationException when the user cannot be found
+     */
     public function getUser(): UserInterface;
 }