improvements for #744

Author: mevdschee

README.md

@@ -554,10 +554,25 @@ contain the same number of objects as there are primary keys in the URL:
 
 This adjusts the titles of the posts. And the return values are the number of rows that are set:
 
-    1,1
+    [1,1]
 
 Which means that there were two update operations and each of them had set one row. Batch operations use database
-transactions, so they either all succeed or all fail (successful ones get roled back).
+transactions, so they either all succeed or all fail (successful ones get roled back). If they fail the body will
+contain the list of error documents. In the following response the first operation succeeded and the second operation
+of the batch failed due to an integrity violation:
+
+    [   
+        {
+            "code": 0,
+            "message": "Success"
+        },
+        {
+            "code": 1010,
+            "message": "Data integrity violation"
+        }
+    ]
+
+The response status code will always be 424 (failed dependency) in case of failure of one of the batch operations.
 
 ### Spatial support
 

src/Tqdev/PhpCrudApi/Controller/JsonResponder.php

@@ -39,17 +39,21 @@ public function exception($exception): ResponseInterface
 
     public function multi($results): ResponseInterface
     {
-        $document = array();
+        $documents = array();
+        $errors = array();
         $success = true;
         foreach ($results as $i=>$result) {
             if ($result instanceof \Throwable) {
-                $document[$i] = ErrorDocument::fromException($result);
+                $documents[$i] = null;
+                $errors[$i] = ErrorDocument::fromException($result);
                 $success = false;
             } else {
-                $document[$i] = $result;
+                $documents[$i] = $result;
+                $errors[$i] = new ErrorDocument(new ErrorCode(0),'',null);
             }
         }
         $status = $success ? ResponseFactory::OK : ResponseFactory::FAILED_DEPENDENCY;
+        $document = $success ? $documents : $errors;
         $response = ResponseFactory::fromObject($status, $document);
         foreach ($results as $i=>$result) {
             if ($result instanceof \Throwable) {

src/Tqdev/PhpCrudApi/Record/Document/ErrorDocument.php

@@ -43,7 +43,7 @@ public function serialize()
 
     public function jsonSerialize()
     {
-        return array_filter($this->serialize());
+        return array_filter($this->serialize(), function($v) {return $v!==null;});
     }
 
     public static function fromException(\Throwable $exception)

src/Tqdev/PhpCrudApi/Record/ErrorCode.php

@@ -35,7 +35,7 @@ class ErrorCode
     const PASSWORD_TOO_SHORT = 1021;
 
     private $values = [
-        9999 => ["%s", ResponseFactory::INTERNAL_SERVER_ERROR],
+        0000 => ["Success", ResponseFactory::OK],
         1000 => ["Route '%s' not found", ResponseFactory::NOT_FOUND],
         1001 => ["Table '%s' not found", ResponseFactory::NOT_FOUND],
         1002 => ["Argument count mismatch in '%s'", ResponseFactory::UNPROCESSABLE_ENTITY],
@@ -58,6 +58,7 @@ class ErrorCode
         1019 => ["Pagination forbidden", ResponseFactory::FORBIDDEN],
         1020 => ["User '%s' already exists", ResponseFactory::CONFLICT],
         1021 => ["Password too short (<%d characters)", ResponseFactory::UNPROCESSABLE_ENTITY],
+        9999 => ["%s", ResponseFactory::INTERNAL_SERVER_ERROR],
     ];
 
     public function __construct(int $code)

tests/functional/001_records/090_add_multiple_comments.log

@@ -23,9 +23,9 @@ POST /records/comments
 ===
 424
 Content-Type: application/json; charset=utf-8
-Content-Length: 54
+Content-Length: 83
 
-[9,{"code":1010,"message":"Data integrity violation"}]
+[{"code":0,"message":"Success"},{"code":1010,"message":"Data integrity violation"}]
 ===
 GET /records/comments?include=id&filter=post_id,eq,6
 ===

tests/functional/001_records/091_edit_multiple_comments.log

@@ -23,9 +23,9 @@ PUT /records/comments/7,8
 ===
 424
 Content-Type: application/json; charset=utf-8
-Content-Length: 54
+Content-Length: 83
 
-[1,{"code":1010,"message":"Data integrity violation"}]
+[{"code":0,"message":"Success"},{"code":1010,"message":"Data integrity violation"}]
 ===
 GET /records/comments?include=message&filter=post_id,eq,6
 ===