Implement API to many relations (#69)

* Implement API to many relations

• Added method to process belongToMany and morphToMany relationships.

* Added notes about relationship sync

* Apply fixes from StyleCI (#70)

Co-authored-by: Craig Smith <[email protected]>

Co-authored-by: Craig Smith <[email protected]>
Co-authored-by: Craig Smith <[email protected]>

Author: samatcd

README.md

@@ -156,6 +156,12 @@ Simply add a `protected static $mapResources` to your `Resource` to define which
     ];
 ```
 
+- You can automatically update and create related records for most types of relationships. Just include the related resource name in your POST or PUT request.
+
+For `BelongsToMany` or `MorphToMany` relationships, you can choose the sync strategy. By default, this will take an *additive* strategy. That is to say, related records sent will be ADDED to any existing related records. On a request-by-request basis, you can opt for a *sync* strategy which will remove the pivot for any related records not listed in the request. Note the actual related record will not be removed, just the pivot entry.
+
+To opt for the *sync* behavaiour, set `?sync[field]=true` in your request.
+
 ## Sorting
 
 -   Sorts can be passed as comma list aswell, ie `sort=age asc` or `sort=age asc,name desc,eyes` - generates sql of `sort age asc` and `sort age asc, name desc, eyes asc` respectively

src/Contracts/Parser.php

@@ -201,8 +201,8 @@ protected function parseFilterParams(): void
     protected function parseMethodParams($request): void
     {
         foreach ($this->/** @scrutinizer ignore-call */ getAllowedScopes() as $scope) {
-            if ($request->has(Helpers::snake($scope)) || $request->has(Helpers::camel($scope)) ) {
-                $value = $request->has(Helpers::snake($scope)) ? $request->get(Helpers::snake($scope)) :  $request->get(Helpers::camel($scope));
+            if ($request->has(Helpers::snake($scope)) || $request->has(Helpers::camel($scope))) {
+                $value = $request->has(Helpers::snake($scope)) ? $request->get(Helpers::snake($scope)) : $request->get(Helpers::camel($scope));
                 call_user_func([$this->repository, Helpers::camel($scope)], $value);
             }
         }

src/Contracts/Relationships.php

@@ -88,7 +88,7 @@ protected function storeRelated($item, array $includes, array $data): void
             $relation = $item->$with();
             $type = class_basename(get_class($relation));
 
-            if (! in_array($type, ['HasOne', 'HasMany', 'BelongsTo', 'BelongsToMany', 'MorphOne','MorphMany'])) {
+            if (! in_array($type, ['HasOne', 'HasMany', 'BelongsTo', 'MorphOne', 'MorphMany', 'MorphTo', 'MorphToMany', 'BelongsToMany'])) {
                 throw new ApiException("$type mapping not implemented yet");
             }
 
@@ -106,10 +106,12 @@ protected function storeRelated($item, array $includes, array $data): void
                     $this->processHasRelation($relation, $relatedRecords, $item);
                     break;
                 case 'BelongsTo':
-                    $this->processBelongsToRelation($relation, [$relatedRecords], $item, $data);
+                case 'MorphTo':
+                    $this->processBelongsToRelation($relation, $relatedRecords, $item, $data);
                     break;
                 case 'BelongsToMany':
-                    $this->processBelongsToRelation($relation, $relatedRecords, $item, $data);
+                case 'MorphToMany':
+                    $this->processBelongsToManyRelation($relation, $relatedRecords, $item, $data, $with);
                     break;
             }
         }
@@ -157,33 +159,59 @@ protected function processHasRelation($relation, array $relatedRecords, $item):
         }
     }
 
-    protected function processBelongsToRelation($relation, array $relatedRecords, $item, array $data): void
+    protected function processBelongsToRelation($relation, $relatedRecord, $item, array $data): void
     {
         $ownerKey = $relation->getOwnerKeyName();
         $localKey = $relation->getForeignKeyName();
 
         $model = $relation->getRelated();
 
+        if (! isset($relatedRecord[$ownerKey])) {
+            $relatedRecord[$ownerKey] = $item->getAttribute($localKey);
+        }
+        if ($relatedRecord[$ownerKey]) {
+            $existanceCheck = [$ownerKey => $relatedRecord[$ownerKey]];
+            $relation->associate(
+                $model->updateOrCreate($existanceCheck, $relatedRecord)
+            );
+        } elseif (isset($data[$localKey])) {
+            $existanceCheck = [$ownerKey => $data[$localKey]];
+            $relation->associate(
+                $model->updateOrCreate($existanceCheck, $relatedRecord)
+            );
+        } else {
+            $relation->associate(
+                $model->create($relatedRecord)
+            );
+        }
+        $item->save();
+    }
+
+    protected function processBelongsToManyRelation($relation, array $relatedRecords, $item, array $data, $with): void
+    {
+        $parentKey = $relation->getParentKeyName();
+        $relatedKey = $relation->getRelatedKeyName();
+
+        $model = $relation->getRelated();
+        $sync = collect();
+
         foreach ($relatedRecords as $relatedRecord) {
-            if (! isset($relatedRecord[$ownerKey])) {
-                $relatedRecord[$ownerKey] = $item->getAttribute($localKey);
+            if (! isset($relatedRecord[$parentKey])) {
+                $relatedRecord[$parentKey] = $item->getAttribute($relatedKey);
             }
-            if ($relatedRecord[$ownerKey]) {
-                $existanceCheck = [$ownerKey => $relatedRecord[$ownerKey]];
-                $relation->associate(
-                    $model->updateOrCreate($existanceCheck, $relatedRecord)
-                );
-            } elseif (isset($data[$localKey])) {
-                $existanceCheck = [$ownerKey => $data[$localKey]];
-                $relation->associate(
-                    $model->updateOrCreate($existanceCheck, $relatedRecord)
-                );
+            if ($relatedRecord[$parentKey]) {
+                $existanceCheck = [$parentKey => $relatedRecord[$parentKey]];
+                $sync->push($model->updateOrCreate($existanceCheck, $relatedRecord));
+            } elseif (isset($data[$relatedKey])) {
+                $existanceCheck = [$parentKey => $data[$relatedKey]];
+                $sync->push($model->updateOrCreate($existanceCheck, $relatedRecord));
             } else {
-                $relation->associate(
-                    $model->create($relatedRecord)
-                );
+                $sync->push($model->create($relatedRecord));
             }
-            $item->save();
         }
+
+        $detach = filter_var(request()->get('sync')[$with] ?? false, FILTER_VALIDATE_BOOLEAN);
+
+        $relation->sync($sync->pluck('id'), $detach);
     }
 }

src/Http/Resources/Contracts/AllowableFields.php

@@ -71,15 +71,14 @@ protected function mapRelatedResources($resources)
 
     protected function mapFieldData($request, $fields)
     {
-
         $data = parent::toArray($request);
 
-        $missing = array_filter($fields, function($field) use ($data){
+        $missing = array_filter($fields, function ($field) use ($data) {
             return array_key_exists(Helpers::camel($field), $data) || array_key_exists(Helpers::snake($field), $data) ? false : true;
         });
 
-        foreach($missing as $field){
-            if(method_exists($this->resource, 'get' . Helpers::camel($field) . 'Attribute')){
+        foreach ($missing as $field) {
+            if (method_exists($this->resource, 'get'.Helpers::camel($field).'Attribute')) {
                 $data[$field] = $this->resource->{ Helpers::camel($field)};
             }
         }

src/Repository/BaseRepository.php

@@ -2,12 +2,11 @@
 
 namespace Phpsa\LaravelApiController\Repository;
 
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Support\Collection as BaseCollection;
 use Phpsa\LaravelApiController\Exceptions\ApiException;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
-use Illuminate\Pagination\LengthAwarePaginator;
 
 /**
  * Class BaseRepository.