symfony · nicolas-grekas · Aug 3, 2023 · May 23, 2023
@@ -29,6 +29,10 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ *
+ * @template TUser of UserInterface
+ *
+ * @template-implements UserProviderInterface<TUser>
  */
 class EntityUserProvider implements UserProviderInterface, PasswordUpgraderInterface
 {

@@ -30,6 +30,8 @@
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  * @author Charles Sarrazin <charles@sarraz.in>
  * @author Robin Chalas <robin.chalas@gmail.com>
+ *
+ * @template-implements UserProviderInterface<LdapUser>
  */
 class LdapUserProvider implements UserProviderInterface, PasswordUpgraderInterface
 {

@@ -18,6 +18,10 @@
  * This is particularly useful with self-contained access tokens.
  *
  * @experimental
+ *
+ * @template-covariant TUser of UserInterface
+ *
+ * @template-extends UserProviderInterface<TUser>
  */
 interface AttributesBasedUserProviderInterface extends UserProviderInterface
 {
@@ -26,6 +30,8 @@ interface AttributesBasedUserProviderInterface extends UserProviderInterface
      *
      * This method must throw UserNotFoundException if the user is not found.
      *
+     * @return TUser
+     *
      * @throws UserNotFoundException
      */
     public function loadUserByIdentifier(string $identifier, array $attributes = []): UserInterface;

@@ -21,6 +21,8 @@
  * handle the request.
  *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ *
+ * @template-implements UserProviderInterface<UserInterface>
  */
 class ChainUserProvider implements UserProviderInterface, PasswordUpgraderInterface
 {

@@ -21,6 +21,8 @@
  * (a backend with a unique admin for instance)
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @template-implements UserProviderInterface<InMemoryUser>
  */
 class InMemoryUserProvider implements UserProviderInterface
 {

@@ -18,6 +18,8 @@
  * when a firewall requires a user provider but none was defined.
  *
  * @internal
+ *
+ * @template-implements UserProviderInterface<never>
  */
 class MissingUserProvider implements UserProviderInterface
 {

@@ -28,6 +28,8 @@
  * information is submitted or what the UserInterface object looks like.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @template-covariant TUser of UserInterface
  */
 interface UserProviderInterface
 {
@@ -41,6 +43,8 @@ interface UserProviderInterface
      *
      * @return UserInterface
      *
+     * @psalm-return TUser
+     *
      * @throws UnsupportedUserException if the user is not supported
      * @throws UserNotFoundException    if the user is not found
      */
@@ -58,6 +62,8 @@ public function supportsClass(string $class);
      *
      * This method must throw UserNotFoundException if the user is not found.
      *
+     * @return TUser
+     *
      * @throws UserNotFoundException
      */
     public function loadUserByIdentifier(string $identifier): UserInterface;