Merge pull request #64 from tuyakhov/allow_deleting_resources

Allow deleting underlying resources

Author: tuyakhov

src/ResourceTrait.php

@@ -12,6 +12,12 @@
 
 trait ResourceTrait
 {
+    /**
+     * @var bool a flag that enables/disables deleting of the model that contains the foreign key when setting relationships
+     * By default the model's foreign key will be set `null` and saved.
+     */
+    public $allowDeletingResources = false;
+
     /**
      * @return string
      */
@@ -87,7 +93,7 @@ public function setResourceRelationship($name, $relationship)
         if (!is_array($relationship)) {
             $relationship = [$relationship];
         }
-        $this->unlinkAll($name);
+        $this->unlinkAll($name, $this->allowDeletingResources);
         foreach ($relationship as $key => $value) {
             if ($value instanceof ActiveRecordInterface) {
                 $this->link($name, $value);

src/actions/Action.php

@@ -6,6 +6,7 @@
 namespace tuyakhov\jsonapi\actions;
 
 use tuyakhov\jsonapi\ResourceInterface;
+use tuyakhov\jsonapi\ResourceTrait;
 use yii\db\ActiveRecordInterface;
 use yii\db\BaseActiveRecord;
 use yii\helpers\ArrayHelper;
@@ -23,6 +24,11 @@ class Action extends \yii\rest\Action
      */
     public $allowFullReplacement = true;
 
+    /**
+     * @var bool Weather allow to delete the underlying resource if a relationship is deleted (as a garbage collection measure)
+     */
+    public $enableResourceDeleting = false;
+
     /**
      * Links the relationships with primary model.
      * @param $model ActiveRecordInterface
@@ -59,6 +65,12 @@ protected function linkRelationships($model, array $data = [])
                 continue;
             }
             $records = $relatedClass::find()->andWhere(['in', $relatedClass::primaryKey(), $ids])->all();
+
+            /** @see ResourceTrait::$allowDeletingResources */
+            if (property_exists($model, 'allowDeletingResources')) {
+                $model->allowDeletingResources = $this->enableResourceDeleting;
+            }
+
             $model->setResourceRelationship($name, $records);
         }
     }

src/actions/DeleteRelationshipAction.php

@@ -90,7 +90,7 @@ protected function unlinkRelationships($model, array $data = [])
 
             $records = $relatedClass::find()->andWhere(['in', $relatedClass::primaryKey(), $ids])->all();
             foreach ($records as $record) {
-                $model->unlink($name, $record);
+                $model->unlink($name, $record, $this->enableResourceDeleting);
             }
         }
     }

tests/data/ResourceModel.php

@@ -88,7 +88,7 @@ public function getPrimaryKey($asArray = false)
         return $asArray ? [$this->getId()] : $this->getId();
     }
 
-    public function unlinkAll($name)
+    public function unlinkAll($name, $delete = false)
     {
         $this->$name = null;
     }