first version

2019-01-13 23:17:34 +01:00
commit 01277f79f2
595 changed files with 82913 additions and 0 deletions
--- a/kirby/src/Api/Model.php
+++ b/kirby/src/Api/Model.php
@@ -0,0 +1,188 @@
+<?php
+
+namespace Kirby\Api;
+
+use Closure;
+use Exception;
+
+use Kirby\Toolkit\Str;
+
+/**
+ * The API Model class can be wrapped around any
+ * kind of object. Each model defines a set of properties that
+ * are availabel in REST calls. Those properties are defined as
+ * simple Closures which are resolved on demand. This is inspired
+ * by GraphQLs architecture and makes it possible to load
+ * only the model data that is needed for the current API call.
+ *
+ */
+class Model
+{
+    protected $api;
+    protected $data;
+    protected $fields;
+    protected $select;
+    protected $views;
+
+    public function __construct(Api $api, $data = null, array $schema)
+    {
+        $this->api    = $api;
+        $this->data   = $data;
+        $this->fields = $schema['fields'] ?? [];
+        $this->select = $schema['select'] ?? null;
+        $this->views  = $schema['views']  ?? [];
+
+        if ($this->select === null && array_key_exists('default', $this->views)) {
+            $this->view('default');
+        }
+
+        if ($data === null) {
+            if (is_a($schema['default'] ?? null, 'Closure') === false) {
+                throw new Exception('Missing model data');
+            }
+
+            $this->data = $schema['default']->call($this->api);
+        }
+
+        if (isset($schema['type']) === true && is_a($this->data, $schema['type']) === false) {
+            throw new Exception(sprintf('Invalid model type "%s" expected: "%s"', get_class($this->data), $schema['type']));
+        }
+    }
+
+    public function select($keys = null)
+    {
+        if ($keys === false) {
+            return $this;
+        }
+
+        if (is_string($keys)) {
+            $keys = Str::split($keys);
+        }
+
+        if ($keys !== null && is_array($keys) === false) {
+            throw new Exception('Invalid select keys');
+        }
+
+        $this->select = $keys;
+        return $this;
+    }
+
+    public function selection(): array
+    {
+        $select = $this->select;
+
+        if ($select === null) {
+            $select = array_keys($this->fields);
+        }
+
+        $selection = [];
+
+        foreach ($select as $key => $value) {
+            if (is_int($key) === true) {
+                $selection[$value] = [
+                    'view'   => null,
+                    'select' => null
+                ];
+                continue;
+            }
+
+            if (is_string($value) === true) {
+                if ($value === 'any') {
+                    throw new Exception('Invalid sub view: "any"');
+                }
+
+                $selection[$key] = [
+                    'view'   => $value,
+                    'select' => null
+                ];
+
+                continue;
+            }
+
+            if (is_array($value) === true) {
+                $selection[$key] = [
+                    'view'   => null,
+                    'select' => $value
+                ];
+            }
+        }
+
+        return $selection;
+    }
+
+    public function toArray(): array
+    {
+        $select = $this->selection();
+        $result = [];
+
+        foreach ($this->fields as $key => $resolver) {
+            if (array_key_exists($key, $select) === false || is_a($resolver, 'Closure') === false) {
+                continue;
+            }
+
+            $value = $resolver->call($this->api, $this->data);
+
+            if (is_object($value)) {
+                $value = $this->api->resolve($value);
+            }
+
+            if (is_a($value, 'Kirby\Api\Collection') === true || is_a($value, 'Kirby\Api\Model') === true) {
+                $selection = $select[$key];
+
+                if ($subview = $selection['view']) {
+                    $value->view($subview);
+                }
+
+                if ($subselect = $selection['select']) {
+                    $value->select($subselect);
+                }
+
+                $value = $value->toArray();
+            }
+
+            $result[$key] = $value;
+        }
+
+        ksort($result);
+
+        return $result;
+    }
+
+    public function toResponse(): array
+    {
+        $model = $this;
+
+        if ($select = $this->api->requestQuery('select')) {
+            $model = $model->select($select);
+        }
+
+        if ($view = $this->api->requestQuery('view')) {
+            $model = $model->view($view);
+        }
+
+        return [
+            'code'   => 200,
+            'data'   => $model->toArray(),
+            'status' => 'ok',
+            'type'   => 'model'
+        ];
+    }
+
+    public function view(string $name)
+    {
+        if ($name === 'any') {
+            return $this->select(null);
+        }
+
+        if (isset($this->views[$name]) === false) {
+            $name = 'default';
+
+            // try to fall back to the default view at least
+            if (isset($this->views[$name]) === false) {
+                throw new Exception(sprintf('The view "%s" does not exist', $name));
+            }
+        }
+
+        return $this->select($this->views[$name]);
+    }
+}