Enhance API results and HTTP status/methods

Author: pH-7

src/Dal/UserDal.php

@@ -10,7 +10,7 @@ final class UserDal
 {
     public const TABLE_NAME = 'users';
 
-    public static function create(UserEntity $userEntity): int|string|false
+    public static function create(UserEntity $userEntity): string|false
     {
         $userBean = R::dispense(self::TABLE_NAME);
         $userBean->user_uuid = $userEntity->getUserUuid();
@@ -29,7 +29,10 @@ public static function create(UserEntity $userEntity): int|string|false
             R::close();
         }
 
-        return $redBeanIncrementId;
+        $userBean = R::load(self::TABLE_NAME, $redBeanIncrementId);
+
+        // Return user UUID (UUID is a string datatype)
+        return $userBean->user_uuid;
     }
 
     public static function update(string $userUuid, UserEntity $userEntity): int|string|false
@@ -64,6 +67,7 @@ public static function update(string $userUuid, UserEntity $userEntity): int|str
             }
         }
 
+        // Return false when the requested user isn't found
         return false;
     }
 

src/Route/user.routes.php

@@ -35,11 +35,11 @@ public function getResponse(): string
         $user = new User($jwtToken);
 
         try {
-            // check first if HTTP method for the requested endpoint is valid
+            // first, let's check if HTTP method for the requested endpoint is valid
             $expectHttpMethod = match ($this) {
                 self::LOGIN => Http::POST_METHOD,
                 self::CREATE => Http::POST_METHOD,
-                self::UPDATE => Http::POST_METHOD,
+                self::UPDATE => Http::PUT_METHOD,
                 self::RETRIEVE_ALL => Http::GET_METHOD,
                 self::RETRIEVE => Http::GET_METHOD,
                 self::REMOVE => Http::DELETE_METHOD

src/Service/User.php

@@ -83,9 +83,9 @@ public function create(mixed $data): array|object
                 );
             }
 
-            if (UserDal::create($userEntity) === false) {
-                // Set an internal error 500 when we cannot add an entry to the database
-                HttpResponse::setHeadersByCode(StatusCode::INTERNAL_SERVER_ERROR);
+            if (!$userUuid = UserDal::create($userEntity)) {
+                // If we receive an error while creating a user to the database, give a 400 to client
+                HttpResponse::setHeadersByCode(StatusCode::BAD_REQUEST);
 
                 // Set to empty result, because an issue happened. The client has to handle this properly
                 $data = [];
@@ -94,7 +94,10 @@ public function create(mixed $data): array|object
             // Send a 201 when the user has been successfully added to DB
             HttpResponse::setHeadersByCode(StatusCode::CREATED);
 
-            return $data; // return statement exists the function and doesn't go beyond this scope
+            // Add user UUID to the object to give back the user's UUID to the client
+            $data->userUuid = $userUuid;
+
+            return $data;
         }
 
         throw new InvalidValidationException("Invalid user payload");
@@ -120,8 +123,8 @@ public function update(mixed $postBody): array|object
             }
 
             if (UserDal::update($userUuid, $userEntity) === false) {
-                // Set an internal error 500 when we cannot add an entry to the database
-                HttpResponse::setHeadersByCode(StatusCode::INTERNAL_SERVER_ERROR);
+                // Most likely, the user isn't found, set a 404 to the client
+                HttpResponse::setHeadersByCode(StatusCode::NOT_FOUND);
 
                 // If invalid or got an error, give back an empty response
                 return [];