add checkAccess and prepareRelationships into UpdateRelationshipAction

Author: tuyakhov

src/actions/UpdateRelationshipAction.php

@@ -6,19 +6,30 @@
 namespace tuyakhov\jsonapi\actions;
 
 use tuyakhov\jsonapi\ResourceInterface;
+use yii\base\Model;
 use yii\data\ActiveDataProvider;
 use yii\db\BaseActiveRecord;
 use yii\helpers\ArrayHelper;
 use yii\rest\Action;
 use yii\web\BadRequestHttpException;
 use yii\web\NotFoundHttpException;
 
+/**
+ * UpdateRelationshipAction implements the API endpoint for updating relationships.
+ * @link http://jsonapi.org/format/#crud-updating-relationships
+ */
 class UpdateRelationshipAction extends Action
 {
     /**
-     * @param $id
-     * @param $name
-     * @return array|null|ActiveDataProvider|\yii\db\ActiveRecord|\yii\db\ActiveRecordInterface
+     * Prepares the relationships to link with primary model.
+     * @var callable
+     */
+    public $prepareRelationships;
+    /**
+     * Update of relationships independently.
+     * @param string $id an ID of the primary resource
+     * @param string $name a name of the related resource
+     * @return ActiveDataProvider|BaseActiveRecord
      * @throws BadRequestHttpException
      * @throws NotFoundHttpException
      */
@@ -34,22 +45,12 @@ public function run($id, $name)
         if (!$related = $model->getRelation($name, false)) {
             throw new NotFoundHttpException('Relationship does not exist');
         }
-        $relatedClass = $related->modelClass;
 
-        $data = \Yii::$app->getRequest()->getBodyParams();
-        $data = ArrayHelper::isIndexed($data) ? $data : [$data];
-
-        $ids = [];
-        foreach ($data as $index => $relationshipObject) {
-            if (!isset($relationshipObject['id'])) {
-                continue;
-            }
-            $ids[] = $relationshipObject['id'];
+        if ($this->checkAccess) {
+            call_user_func($this->checkAccess, $this->id, $model, $name);
         }
-        /** @var BaseActiveRecord $relatedClass */
-        $relationships = $relatedClass::find()
-            ->andWhere(['in', $relatedClass::primaryKey(), $ids])
-            ->all();
+
+        $relationships = $this->prepareRelationships($related);
 
         if (!empty($relationships)) {
             $model->unlinkAll($name);
@@ -64,4 +65,34 @@ public function run($id, $name)
             return $related->one();
         }
     }
+
+    protected function prepareRelationships($related)
+    {
+        if ($this->prepareRelationships !== null) {
+            return call_user_func($this->prepareRelationships, $this, $related);
+        }
+
+        /** @var BaseActiveRecord $relatedClass */
+        $relatedClass = new $related->modelClass;
+
+        $data = \Yii::$app->getRequest()->getBodyParams();
+        
+        $data = ArrayHelper::keyExists($relatedClass->formName(), $data) ? $data[$relatedClass->formName()] : [];
+        
+        if (!ArrayHelper::isIndexed($data)) {
+            $data = [$data];
+        }
+
+        $ids = [];
+        foreach ($data as $index => $relationshipObject) {
+            if (!isset($relationshipObject['id'])) {
+                continue;
+            }
+            $ids[] = $relationshipObject['id'];
+        }
+
+        return $relatedClass::find()
+            ->andWhere(['in', $relatedClass::primaryKey(), $ids])
+            ->all();
+    }
 }

src/actions/ViewRelatedAction.php

@@ -37,15 +37,15 @@ public function run($id, $name)
             throw new BadRequestHttpException('Impossible to fetch related resource');
         }
 
-        if ($this->checkAccess) {
-            call_user_func($this->checkAccess, $this->id, $model);
-        }
-
         /** @var ActiveQuery $related */
         if (!$related = $model->getRelation($name, false)) {
             throw new NotFoundHttpException('Resource does not exist');
         }
 
+        if ($this->checkAccess) {
+            call_user_func($this->checkAccess, $this->id, $model, $name);
+        }
+
         if ($this->prepareDataProvider !== null) {
             return call_user_func($this->prepareDataProvider, $this, $related);
         }

tests/actions/UpdateRelationshipActionTest.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\tests\actions;
+
+
+use tuyakhov\jsonapi\actions\UpdateRelationshipAction;
+use tuyakhov\jsonapi\tests\data\ActiveQuery;
+use tuyakhov\jsonapi\tests\data\ResourceModel;
+use tuyakhov\jsonapi\tests\TestCase;
+use yii\base\Controller;
+use yii\data\ActiveDataProvider;
+
+class UpdateRelationshipActionTest extends TestCase
+{
+    public function testSuccess()
+    {
+        $model = new ResourceModel();
+        $action = new UpdateRelationshipAction('test', new Controller('test', \Yii::$app), [
+            'modelClass' => ResourceModel::className()
+        ]);
+        $model->setRelation('multiple', new ActiveQuery(ResourceModel::className(), ['multiple' => true]));
+        $model->setRelation('single', new ActiveQuery(ResourceModel::className()));
+        $action->findModel = function ($id, $action) use($model) {
+            return $model;
+        };
+        ActiveQuery::$models = [new ResourceModel(), new ResourceModel()];
+        \Yii::$app->request->setBodyParams(['ResourceModel' => ['type' => 'resource-models', 'id' => 123]]);
+        $this->assertInstanceOf(ActiveDataProvider::className(), $dataProvider = $action->run(1, 'multiple'));
+        $this->assertEquals(2, count($dataProvider->getModels()));
+        $this->assertInstanceOf(ResourceModel::className(), $action->run(1, 'single'));
+    }
+}

tests/data/ActiveQuery.php

@@ -7,9 +7,22 @@
 
 class ActiveQuery extends \yii\db\ActiveQuery
 {
+    public static $models = [];
+    
     public function one($db = null)
     {
-        return new $this->modelClass;
+        return isset(self::$models[0]) ? self::$models[0] : new $this->modelClass;
     }
 
+    public function all($db = null)
+    {
+        return self::$models;
+    }
+
+    public function count($q = '*', $db = null)
+    {
+        return count(self::$models);
+    }
+
+
 }

tests/data/ResourceModel.php

@@ -52,6 +52,21 @@ public function setRelation($name, $value)
         $this->_related[$name] = $value;
     }
 
+    public static function find()
+    {
+        return new ActiveQuery(self::className());
+    }
+
+    public static function primaryKey()
+    {
+        return ['id'];
+    }
+
+    public function unlinkAll()
+    {
+        return;
+    }
+
     public function getLinks()
     {
         return [