Merge pull request #1196 from kenjis/add-UserModel-createNewUser

feat: add ``UserModel::createNewUser()``  and `RegisterController` uses it

Author: datamweb

docs/customization/user_provider.md

@@ -54,3 +54,17 @@ class UserModel extends ShieldUserModel
     }
 }
 ```
+
+## Creating a Custom User Entity
+
+Starting from v1.2.0, `UserModel` in Shield has the `createNewUser()` method to
+create a new User Entity.
+
+```php
+$user = $userModel->createNewUser($data);
+```
+
+It takes an optional user data array as the first argument, and passes it to the
+constructor of the `$returnType` class.
+
+If your custom User entity cannot be instantiated in this way, override this method.

src/Controllers/RegisterController.php

@@ -103,8 +103,7 @@ public function registerAction(): RedirectResponse
 
         // Save the user
         $allowedPostFields = array_keys($rules);
-        $user              = $this->getUserEntity();
-        $user->fill($this->request->getPost($allowedPostFields));
+        $user              = $users->createNewUser($this->request->getPost($allowedPostFields));
 
         // Workaround for email only registration/login
         if ($user->username === null) {
@@ -160,10 +159,14 @@ protected function getUserProvider(): UserModel
 
     /**
      * Returns the Entity class that should be used
+     *
+     * @deprecated 1.2.0 No longer used.
      */
     protected function getUserEntity(): User
     {
-        return new User();
+        $userProvider = $this->getUserProvider();
+
+        return $userProvider->createNewUser();
     }
 
     /**

src/Models/UserModel.php

@@ -397,4 +397,14 @@ private function checkReturnType(): void
             throw new LogicException('Return type must be a subclass of ' . User::class);
         }
     }
+
+    /**
+     * Returns a new User Entity.
+     *
+     * @param array<string, array<array-key, mixed>|bool|float|int|object|string|null> $data (Optional) user data
+     */
+    public function createNewUser(array $data = []): User
+    {
+        return new $this->returnType($data);
+    }
 }