bug #890 [make:user] Keep implementing deprecated username methods (wouterj, weaverryan)

This PR was merged into the 1.0-dev branch.

Discussion
----------

[make:user] Keep implementing deprecated username methods

This updates the makers for symfony/symfony#41493 (where these methods are reintroduced to the interface for 5.3.1)

Commits
-------

2d9312e Fix tests
bd55d19 Update src/Resources/skeleton/security/UserProvider.tpl.php
c3d4046 Still implement deprecated username method

Author: weaverryan

src/Resources/skeleton/security/UserProvider.tpl.php

@@ -28,6 +28,16 @@ public function <?= $uses_user_identifier ? 'loadUserByIdentifier($identifier)'
         throw new \Exception('TODO: fill in <?= $uses_user_identifier ? 'loadUserByIdentifier()' : 'loadUserByUsername()' ?> inside '.__FILE__);
     }
 
+<?php if ($uses_user_identifier) : ?>
+    /**
+     * @deprecated since Symfony 5.3, loadUserByIdentifier() is used instead
+     */
+    public function loadUserByUsername($username): UserInterface
+    {
+        return $this->loadUserByIdentifier($username);
+    }
+
+<?php endif ?>
     /**
      * Refreshes the user after being reloaded from the session.
      *

src/Security/UserClassBuilder.php

@@ -98,12 +98,9 @@ private function addGetUsername(ClassSourceManipulator $manipulator, UserClassCo
             );
         }
 
-        $getterIdentifierName = 'getUsername';
-
         // Check if we're using Symfony 5.3+ - UserInterface::getUsername() was replaced with UserInterface::getUserIdentifier()
-        if (class_exists(InMemoryUser::class)) {
-            $getterIdentifierName = 'getUserIdentifier';
-        }
+        $symfony53GTE = class_exists(InMemoryUser::class);
+        $getterIdentifierName = $symfony53GTE ? 'getUserIdentifier' : 'getUsername';
 
         // define getUsername (if it was defined above, this will override)
         $manipulator->addAccessorMethod(
@@ -118,6 +115,18 @@ private function addGetUsername(ClassSourceManipulator $manipulator, UserClassCo
             ],
             true
         );
+
+        if ($symfony53GTE) {
+            // also add the deprecated getUsername method
+            $manipulator->addAccessorMethod(
+                $userClassConfig->getIdentityPropertyName(),
+                'getUsername',
+                'string',
+                false,
+                ['@deprecated since Symfony 5.3, use getUserIdentifier instead'],
+                true
+            );
+        }
     }
 
     private function addGetRoles(ClassSourceManipulator $manipulator, UserClassConfiguration $userClassConfig)

tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php

@@ -61,6 +61,14 @@ public function getUserIdentifier(): string
         return (string) $this->email;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->email;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserEntityWithPassword.php

@@ -56,6 +56,14 @@ public function setUserIdentifier(string $userIdentifier): self
         return $this;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->userIdentifier;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php

@@ -56,6 +56,14 @@ public function setUserIdentifier(string $user_identifier): self
         return $this;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->user_identifier;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserEntityWithoutPassword.php

@@ -50,6 +50,14 @@ public function setUserIdentifier(string $userIdentifier): self
         return $this;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->userIdentifier;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserModelWithEmailAsIdentifier.php

@@ -38,6 +38,14 @@ public function getUserIdentifier(): string
         return (string) $this->email;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->email;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserModelWithPassword.php

@@ -33,6 +33,14 @@ public function setUserIdentifier(string $userIdentifier): self
         return $this;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->userIdentifier;
+    }
+
     /**
      * @see UserInterface
      */

tests/Security/fixtures/expected/UserModelWithoutPassword.php

@@ -28,6 +28,14 @@ public function setUserIdentifier(string $userIdentifier): self
         return $this;
     }
 
+    /**
+     * @deprecated since Symfony 5.3, use getUserIdentifier instead
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->userIdentifier;
+    }
+
     /**
      * @see UserInterface
      */