Rework based on #18 Normalize fields

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - '7.2'
   - '7.3'
 
 cache:
@@ -18,11 +17,11 @@ before_script:
 
 after_script:
   - echo $TRAVIS_BRANCH
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.2" ]]; then echo "Sending coverage report"; vendor/bin/test-reporter --coverage-report build/logs/clover.xml; fi
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.2" ]]; then echo "Sending codecov report"; TRAVIS_CMD="" bash <(curl -s https://codecov.io/bash) -f build/logs/clover.xml; fi
+  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.3" ]]; then echo "Sending coverage report"; vendor/bin/test-reporter --coverage-report build/logs/clover.xml; fi
+  - if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.3" ]]; then echo "Sending codecov report"; TRAVIS_CMD="" bash <(curl -s https://codecov.io/bash) -f build/logs/clover.xml; fi
 
 script:
-  - if [[ ${TRAVIS_PHP_VERSION:0:3} != "7.2" ]]; then NC="--no-coverage"; fi
+  - if [[ ${TRAVIS_PHP_VERSION:0:3} != "7.3" ]]; then NC="--no-coverage"; fi
   - ./vendor/phpunit/phpunit/phpunit $NC
 
 notifications:

src/Api.php

@@ -2,6 +2,7 @@
 
 namespace atk4\api;
 
+use atk4\data\Field;
 use atk4\data\Model;
 use Laminas\Diactoros\Request;
 use Laminas\Diactoros\Response\JsonResponse;
@@ -41,6 +42,13 @@ class Api
     /** @var int Response options */
     protected $response_options = JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT;
 
+    /**
+     * @var bool If set to true, the first array element of Model->export
+     *           will be returned (GET single record)
+     *           If not, the array will be returned as-is
+     */
+    public $single_record = true;
+
     /**
      * Reads everything off globals.
      *
@@ -148,14 +156,29 @@ public function exec($callable, $vars = [])
         // if callable function returns agile data model, then export it
         // this is important for REST API implementation
         if ($ret instanceof Model) {
-            $ret = $this->exportModel($ret);
+            $data = [];
+
+            $allowed_fields = $this->getAllowedFields($ret, 'read');
+            if ($this->single_record) {
+                $data = $this->exportModel($ret, $allowed_fields);
+            } else {
+                foreach ($ret as $m) {
+                    $data[] = $this->exportModel($m, $allowed_fields);
+                }
+            }
+
+            $ret = $data;
         }
 
         // no response, just step out
         if ($ret === null) {
             return;
         }
 
+        if ($ret === true) { // manage delete
+            $ret = [];
+        }
+
         // emit successful response
         $this->successResponse($ret);
     }
@@ -185,15 +208,23 @@ protected function call($callable, $vars = [])
      *
      * Extend this method to implement your own field restrictions.
      *
-     * @param Model $m
+     * @param Model $m              Model
+     * @param array $allowed_fields Allowed fields
      *
      * @throws \atk4\data\Exception
+     * @throws \atk4\core\Exception
      *
      * @return array
      */
-    protected function exportModel(Model $m)
+    protected function exportModel(Model $m, array $allowed_fields = [])
     {
-        return $m->export($this->getAllowedFields($m, 'read'));
+        $data = [];
+        foreach ($allowed_fields as $fieldName) {
+            $field = $m->getField($fieldName);
+            $data[$field->actual ?? $fieldName] = $field->toString();
+        }
+
+        return $data;
     }
 
     /**
@@ -241,7 +272,7 @@ protected function loadModelByValue(Model $m, $value)
     protected function getAllowedFields(Model $m, $action = 'read')
     {
         // take model only_fields into account
-        $fields = is_array($m->only_fields) ? $m->only_fields : [];
+        $fields = is_array($m->only_fields) && !empty($m->only_fields) ? $m->only_fields : array_keys($m->getFields());
 
         // limit by apiFields
         if (isset($m->apiFields, $m->apiFields[$action])) {
@@ -296,7 +327,7 @@ protected function successResponse($response)
         // for testing purposes there can be situations when emitter is disabled. then do nothing.
         if ($this->emitter) {
             $this->emitter->emit($this->response);
-            exit;
+            exit; // @todo find a solution to remove this exit.
         }
 
         // @todo Should we also stop script execution if no emitter is defined or just ignore that?
@@ -394,6 +425,7 @@ public function rest($pattern, $model = null, $methods = ['read', 'modify', 'del
         // GET all records
         if (in_array('read', $methods)) {
             $f = function (...$params) use ($model) {
+                $this->single_record = false;
                 if (is_callable($model)) {
                     $model = $this->call($model, $params);
                 }
@@ -416,8 +448,9 @@ public function rest($pattern, $model = null, $methods = ['read', 'modify', 'del
                 $model->onlyFields($this->getAllowedFields($model, 'read'));
 
                 // load model and get field values
-                return $this->loadModelByValue($model, $id)->get();
+                return $this->loadModelByValue($model, $id);
             };
+
             $this->get($pattern.'/:id', $f);
         }
 
@@ -437,7 +470,7 @@ public function rest($pattern, $model = null, $methods = ['read', 'modify', 'del
                 $this->loadModelByValue($model, $id)->save($this->request_data);
                 $model->onlyFields($this->getAllowedFields($model, 'read'));
 
-                return $model->get();
+                return $model;
             };
             $this->patch($pattern.'/:id', $f);
             $this->post($pattern.'/:id', $f);
@@ -457,7 +490,8 @@ public function rest($pattern, $model = null, $methods = ['read', 'modify', 'del
                 $model->onlyFields($this->getAllowedFields($model, 'read'));
 
                 $this->response_code = 201; // http code for created
-                return $model->get();
+
+                return $model;
             };
             $this->post($pattern, $f);
         }