Improved primary key

Author: Martin-4Spaces

ResourceControllerTrait.php

@@ -19,21 +19,22 @@ trait ResourceControllerTrait {
     protected $resource = null;
     public $queryParser;
 
-    public function _getResourceName() : string {
-        if($this->resource)
+    public function _getResourceName(): string {
+        if ($this->resource) {
             return $this->resource;
-        else
-            return str_replace('Controllers', 'Models', singular(get_class($this)).'Model');
+        } else {
+            return str_replace('Controllers', 'Models', singular(get_class($this)) . 'Model');
+        }
     }
 
     public function get($id = 0) {
         /** @var Model|ResourceBaseModelInterface|ResourceModelInterface $model */
         $className = $this->_getResourceName();
         $model = new $className();
         $items = $model->restGet($id, $this->queryParser);
-        if($id)
+        if ($id) {
             $this->_setResource($items->first());
-        else {
+        } else {
             $this->_setResources($items);
         }
         $this->success();
@@ -49,11 +50,11 @@ public function post() {
 
         $data = $this->request->getJSON(true);
 
-        if(is_array($this->request->getJSON())) {
+        if (is_array($this->request->getJSON())) {
 
             /** @var Entity $resources */
             $resources = new $entityName();
-            foreach($data as $dataItem) {
+            foreach ($data as $dataItem) {
                 $resources->add($entityName::post($dataItem));
             }
             $this->_setResources($resources);
@@ -78,12 +79,12 @@ public function put($id = 0) {
 
         $data = $this->request->getJSON(true);
 
-        if(is_array($this->request->getJSON())) {
+        if (is_array($this->request->getJSON())) {
 
             /** @var Entity $resources */
             $resources = new $entityName();
-            foreach($data as $dataItem) {
-                $resources->add($entityName::put(isset($dataItem['id']) ? $dataItem['id'] : 0, $dataItem));
+            foreach ($data as $dataItem) {
+                $resources->add($entityName::put(isset($dataItem[$model->getPrimaryKey()]) ? $dataItem[$model->getPrimaryKey()] : 0, $dataItem));
             }
             $this->_setResources($resources);
 
@@ -102,23 +103,24 @@ public function patch($id = 0) {
 
         /** @var Model $model */
         $model = new $className();
+        $primaryKey = $model->getPrimaryKey();
         /** @var Entity|ResourceEntityInterface $entityName */
         $entityName = $model->returnType;
 
         $data = $this->request->getJSON(true);
 
-        if($id) {
+        if ($id) {
 
             $item = $entityName::patch($id, $data);
             $this->_setResource($item);
 
-        } else if(is_array($data)) {
+        } else if (is_array($data)) {
 
             /** @var Entity $resources */
             $resources = new $entityName();
-            foreach($data as $dataItem) {
-                if(isset($dataItem['id']) && $dataItem['id'] > 0)
-                    $resources->add($entityName::patch($dataItem['id'], $dataItem));
+            foreach ($data as $dataItem) {
+                if (isset($dataItem[$primaryKey]) && $dataItem[$primaryKey] > 0)
+                    $resources->add($entityName::patch($dataItem[$primaryKey], $dataItem));
                 else
                     $resources->add($entityName::post($dataItem));
             }
@@ -134,13 +136,13 @@ public function delete($id) {
 
         /** @var Model|ResourceBaseModelInterface|ResourceModelInterface $model */
         $model = new $className();
-        $model->where('id', $id);
+        $model->where($model->getPrimaryKey(), $id);
 
         /** @var Entity $item */
         $item = $model->find();
 
-        if($item->exists()) {
-            if(!$model->isRestDeleteAllowed($item)) {
+        if ($item->exists()) {
+            if (!$model->isRestDeleteAllowed($item)) {
                 $this->error(ErrorCodes::InsufficientAccess, 403);
                 return;
             }
@@ -153,5 +155,4 @@ public function delete($id) {
     }
 
 
-
 }

ResourceEntityTrait.php

@@ -18,20 +18,20 @@ public static function post($data) {
         Data::debug(get_called_class(), 'post');
         $className = get_called_class();
 
+        /** @var ResourceEntityInterface|Entity $item */
+        $item = new $className();
+        /** @var Model|ResourceBaseModelInterface|ResourceModelInterface $model */
+        $model = $item->_getModel();
+
         // NB !! Is this okay? Client want to send relations as objects. But post should always create.
         if(isset($data['id']) && $data['id'] > 0) {
             /** @var Entity $entity */
             $entity = new $className();
-            $entity->find($data['id']); // Have to do a get, it might be saved later
+            $entity->find($data[$model->getPrimaryKey()]); // Have to do a get, it might be saved later
             $entity->fill($data);
             return $entity;
         }
 
-        /** @var ResourceEntityInterface|Entity $item */
-        $item = new $className();
-        /** @var Model|ResourceBaseModelInterface|ResourceModelInterface $model */
-        $model = $item->_getModel();
-
         $item->populatePatch($data);
         if(!$model->isRestCreationAllowed($item)) {
             Data::debug(get_class($item), "ERROR", ErrorCodes::InsufficientAccess);
@@ -97,7 +97,7 @@ public static function put($id, $data) {
         $model = $item->_getModel();
 
         $item = $model
-            ->where('id', $id)
+            ->where($model->getPrimaryKey(), $id)
             ->find();
         $item->populatePut($data);
         if(!$model->isRestUpdateAllowed($item)) {
@@ -198,7 +198,7 @@ public static function patch($id, $data) {
         $model = $item->_getModel();
 
         $item = $model
-            ->where('id', $id)
+            ->where($model->getPrimaryKey(), $id)
             ->find();
         if($item->populatePatch($data)) {
             if(!$model->isRestUpdateAllowed($item)) {