Use User Entity for retriving users and user by email/ID

Author: pH-7

src/Dal/UserDal.php

@@ -67,26 +67,43 @@ public static function update(string $userUuid, UserEntity $userEntity): int|str
         return false;
     }
 
-    public static function getById(string $userUuid): ?array
+    public static function getById(string $userUuid): UserEntity
     {
         $bindings = ['userUuid' => $userUuid];
         $userBean = R::findOne(self::TABLE_NAME, 'user_uuid = :userUuid ', $bindings);
 
-       return $userBean?->export();
+        return (new UserEntity())->unserialize($userBean?->export());
     }
 
-    public static function getByEmail(string $email): ?array
+    public static function getByEmail(string $email): UserEntity
     {
         $bindings = ['email' => $email];
 
         $userBean = R::findOne(self::TABLE_NAME, 'email = :email', $bindings);
 
-        return $userBean?->export();
+        return (new UserEntity())->unserialize($userBean?->export());
     }
 
-    public static function getAll(): array
+    public static function getAll(): ?array
     {
-        return R::findAll(self::TABLE_NAME);
+        $usersBean =  R::findAll(self::TABLE_NAME);
+        $areAnyUsers = $usersBean && count($usersBean);
+
+        if (!$areAnyUsers) {
+            return []; // guard clause approach
+        }
+
+        return array_map(function (object $userBean): array {
+            $userEntity = (new UserEntity())->unserialize($userBean?->export());
+            // Retrieve the User entity fields we want to expose to the client
+            return [
+                'userUuid' => $userEntity->getUserUuid(),
+                'first' => $userEntity->getFirstName(),
+                'last' => $userEntity->getLastName(),
+                'email' => $userEntity->getEmail(),
+                'phone' => $userEntity->getPhone(),
+                'creationDate' => $userEntity->getCreationDate()
+            ];}, $usersBean);
     }
 
     public static function remove(string $userUuid): bool

src/Entity/User.php

@@ -4,7 +4,8 @@
 
 class User
 {
-    private string $userUuid;
+    private int $sequentialId;
+    private ?string $userUuid = null;
 
     private ?string $firstName = null;
 
@@ -16,7 +17,19 @@ class User
 
     private string $password;
 
-    private string $creationDate;
+    private ?string $creationDate = null;
+
+    public function setSequentialId(int $sequentialId): self
+    {
+        $this->sequentialId = $sequentialId;
+
+        return $this;
+    }
+
+    public function getSequentialId(): int
+    {
+        return $this->sequentialId;
+    }
 
     public function setUserUuid(string $userUuid) :self
     {
@@ -25,7 +38,7 @@ public function setUserUuid(string $userUuid) :self
         return $this;
     }
 
-    public function getUserUuid(): string
+    public function getUserUuid(): ?string
     {
         return $this->userUuid;
     }
@@ -97,8 +110,52 @@ public function setCreationDate(string $creationDate): self
         return $this;
     }
 
-    public function getCreationDate(): string
+    public function getCreationDate(): ?string
     {
         return $this->creationDate;
     }
+
+    public function unserialize(?array $data): self
+    {
+        if (!empty($data['id'])) {
+            $this->setSequentialId($data['id']);
+        }
+
+        if (!empty($data['user_uuid'])) {
+            $this->setUserUuid($data['user_uuid']);
+        }
+
+        if (!empty($data['first_name'])) {
+            $this->setFirstName($data['first_name']);
+        }
+
+        if (!empty($data['last_name'])) {
+            $this->setLastName($data['last_name']);
+        }
+
+        if (!empty($data['email'])) {
+            $this->setEmail($data['email']);
+        }
+
+        if (!empty($data['phone'])) {
+            $this->setPhone($data['phone']);
+        }
+
+        if (!empty($data['password'])) {
+            $this->setPassword($data['password']);
+        }
+
+        if (!empty($data['created_date'])) {
+            $this->setCreationDate($data['created_date']);
+        }
+
+        return $this;
+    }
+
+//    public function serialize(): array
+//    {
+//        // optional. we could also only return the properties we want to make it safe
+//        // (not all properties should indeed be returned)
+//        return get_object_vars($this);
+//    }
 }

src/Service/User.php

@@ -24,8 +24,8 @@ public function login(mixed $data): array
             if (UserDal::doesEmailExist($data->email)) {
                 $user = UserDal::getByEmail($data->email);
 
-                if ($user && password_verify($data->password, $user['password'])) {
-                    $userName = "{$user['first_name']} {$user['last_name']}";
+                if ($user->getEmail() && password_verify($data->password, $user->getPassword())) {
+                    $userName = "{$user->getFirstName()} {$user->getLastName()}";
 
                     $currentTime = time();
                     $jwtToken = JWT::encode(
@@ -128,23 +128,24 @@ public function update(mixed $postBody): array|object
 
     public function retrieveAll(): array
     {
-        $users = UserDal::getAll();
-
-        return array_map(function (object $user): object {
-            // Remove unnecessary "id" field
-            unset($user['id']);
-            return $user;
-        }, $users);
+        return UserDal::getAll();
     }
 
     public function retrieve(string $userUuid): array
     {
         if (v::uuid()->validate($userUuid)) {
             if ($user = UserDal::getById($userUuid)) {
-                // Removing fields we don't want to expose
-                unset($user['id']);
-
-                return $user;
+                if ($user->getUserUuid()) {
+                    // Retrieve the needed properties we want to expose for the user
+                    return [
+                        'userUuid' => $user->getUserUuid(),
+                        'first' => $user->getFirstName(),
+                        'last' => $user->getLastName(),
+                        'email' => $user->getEmail(),
+                        'phone' => $user->getPhone(),
+                        'creationDate' => $user->getCreationDate()
+                    ];
+                }
             }
 
             return [];