[DoctrineBridge] Rename UserLoaderInterface::loadUserByUsername() to loadUserByIdentifier()

wouterj · wouterj · commit dd44510fa73d · 2021-03-28T18:49:58.000+02:00
diff --git a/UPGRADE-5.3.md b/UPGRADE-5.3.md
@@ -9,6 +9,7 @@ Asset
 DoctrineBridge
 --------------
 
+ * Deprecate `UserLoaderInterface::loadUserByUsername()` in favor of `UserLoaderInterface::loadUserByIdentifier()
  * Remove `UuidV*Generator` classes
 
 DomCrawler
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -6,6 +6,11 @@ Asset
 
  * Removed `RemoteJsonManifestVersionStrategy`, use `JsonManifestVersionStrategy` instead.
 
+DoctrineBridge
+--------------
+
+ * Remove `UserLoaderInterface::loadUserByUsername()` in favor of `UserLoaderInterface::loadUserByIdentifier()
+
 Config
 ------
 
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 5.3
 ---
 
+ * Deprecate `UserLoaderInterface::loadUserByUsername()` in favor of `UserLoaderInterface::loadUserByIdentifier()
  * Deprecate `DoctrineTestHelper` and `TestRepositoryFactory`
  * [BC BREAK] Remove `UuidV*Generator` classes
  * Add `UuidGenerator`
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php
@@ -66,7 +66,14 @@ public function loadUserByIdentifier(string $identifier): UserInterface
                 throw new \InvalidArgumentException(sprintf('You must either make the "%s" entity Doctrine Repository ("%s") implement "Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface" or set the "property" option in the corresponding entity provider configuration.', $this->classOrAlias, get_debug_type($repository)));
             }
 
-            $user = $repository->loadUserByUsername($identifier);
+            // @deprecated since 5.3, change to $repository->loadUserByIdentifier() in 6.0
+            if (method_exists($repository, 'loadUserByIdentifier')) {
+                $user = $repository->loadUserByIdentifier($identifier);
+            } else {
+                trigger_deprecation('symfony/doctrine-bridge', '5.3', 'Not implementing method "loadUserByIdentifier()" in user loader "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($repository));
+
+                $user = $repository->loadUserByUsername($identifier);
+            }
         }
 
         if (null === $user) {
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/UserLoaderInterface.php b/src/Symfony/Bridge/Doctrine/Security/User/UserLoaderInterface.php
@@ -22,16 +22,11 @@
  *
  * @see UserInterface
  *
+ * @method UserInterface|null loadUserByIdentifier(string $identifier) loads the user for the given user identifier (e.g. username or email).
+ *                                                                     This method must return null if the user is not found.
+ *
  * @author Michal Trojanowski <michal@kmt-studio.pl>
  */
 interface UserLoaderInterface
 {
-    /**
-     * Loads the user for the given username.
-     *
-     * This method must return null if the user is not found.
-     *
-     * @return UserInterface|null
-     */
-    public function loadUserByUsername(string $username);
 }
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php
@@ -70,7 +70,7 @@ public function testLoadUserByUsernameWithUserLoaderRepositoryAndWithoutProperty
         $repository = $this->createMock(UserLoaderRepository::class);
         $repository
             ->expects($this->once())
-            ->method('loadUserByUsername')
+            ->method('loadUserByIdentifier')
             ->with('user1')
             ->willReturn($user);
 
@@ -153,7 +153,7 @@ public function testLoadUserByUserNameShouldLoadUserWhenProperInterfaceProvided(
     {
         $repository = $this->createMock(UserLoaderRepository::class);
         $repository->expects($this->once())
-            ->method('loadUserByUsername')
+            ->method('loadUserByIdentifier')
             ->with('name')
             ->willReturn(
                 $this->createMock(UserInterface::class)
@@ -231,6 +231,7 @@ private function createSchema($em)
 
 abstract class UserLoaderRepository implements ObjectRepository, UserLoaderInterface
 {
+    abstract public function loadUserByIdentifier(string $identifier): ?UserInterface;
 }
 
 abstract class PasswordUpgraderRepository implements ObjectRepository, PasswordUpgraderInterface

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,14 @@ public function loadUserByIdentifier(string $identifier): UserInterface`
`66`	`66`	`throw new \InvalidArgumentException(sprintf('You must either make the "%s" entity Doctrine Repository ("%s") implement "Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface" or set the "property" option in the corresponding entity provider configuration.', $this->classOrAlias, get_debug_type($repository)));`
`67`	`67`	`}`
`68`	`68`
`69`		`- $user = $repository->loadUserByUsername($identifier);`
	`69`	`+ // @deprecated since 5.3, change to $repository->loadUserByIdentifier() in 6.0`
	`70`	`+ if (method_exists($repository, 'loadUserByIdentifier')) {`
	`71`	`+ $user = $repository->loadUserByIdentifier($identifier);`
	`72`	`+ } else {`
	`73`	`+ trigger_deprecation('symfony/doctrine-bridge', '5.3', 'Not implementing method "loadUserByIdentifier()" in user loader "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($repository));`
	`74`	`+`
	`75`	`+ $user = $repository->loadUserByUsername($identifier);`
	`76`	`+ }`
`70`	`77`	`}`
`71`	`78`
`72`	`79`	`if (null === $user) {`
Original file line number	Diff line number	Diff line change
`@@ -22,16 +22,11 @@`
`22`	`22`	`*`
`23`	`23`	`* @see UserInterface`
`24`	`24`	`*`
	`25`	`+ * @method UserInterface\|null loadUserByIdentifier(string $identifier) loads the user for the given user identifier (e.g. username or email).`
	`26`	`+ * This method must return null if the user is not found.`
	`27`	`+ *`
`25`	`28`	`* @author Michal Trojanowski <michal@kmt-studio.pl>`
`26`	`29`	`*/`
`27`	`30`	`interface UserLoaderInterface`
`28`	`31`	`{`
`29`		`- /**`
`30`		`- * Loads the user for the given username.`
`31`		`- *`
`32`		`- * This method must return null if the user is not found.`
`33`		`- *`
`34`		`- * @return UserInterface\|null`
`35`		`- */`
`36`		`- public function loadUserByUsername(string $username);`
`37`	`32`	`}`