improve dx and document auth exception

jrushlow · jrushlow · commit 97ceba0f5d75 · 2021-04-01T11:29:25.000-04:00
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Passport/Badge/UserBadge.php b/src/Symfony/Component/Security/Http/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/src/Symfony/Component/Security/Http/Authenticator/Passport/Passport.php b/src/Symfony/Component/Security/Http/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/src/Symfony/Component/Security/Http/Authenticator/Passport/UserPassportInterface.php b/src/Symfony/Component/Security/Http/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;
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Security\Http\Authenticator\Passport\Badge;`
`13`	`13`
	`14`	`+use Symfony\Component\Security\Core\Exception\AuthenticationException;`
`14`	`15`	`use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;`
`15`	`16`	`use Symfony\Component\Security\Core\User\UserInterface;`
`16`	`17`	`use Symfony\Component\Security\Http\EventListener\UserProviderListener;`
`@@ -55,6 +56,9 @@ public function getUserIdentifier(): string`
`55`	`56`	`return $this->userIdentifier;`
`56`	`57`	`}`
`57`	`58`
	`59`	`+ /**`
	`60`	`+ * @throws AuthenticationException when the user cannot be found`
	`61`	`+ */`
`58`	`62`	`public function getUser(): UserInterface`
`59`	`63`	`{`
`60`	`64`	`if (null === $this->user) {`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,9 @@ public function __construct($userBadge, CredentialsInterface $credentials, array`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
	`58`	`+ /**`
	`59`	`+ * {@inheritdoc}`
	`60`	`+ */`
`58`	`61`	`public function getUser(): UserInterface`
`59`	`62`	`{`
`60`	`63`	`if (null === $this->user) {`