Add get update and delete related by identifier

Admin · Admin · commit 55c7b9016db0 · 2025-02-13T18:43:01.000+02:00
diff --git a/README.md b/README.md
@@ -65,6 +65,14 @@ Extend:
 
 Create a Controller that uses ResourceControllerTrait and call $this->init() from its __construct.
 
+Optionally if you don't want to expose some models as resources but, you want to expose them as relation on an exposed resource then define in your Base Controller or ResourceController:
+
+```php
+    protected array $relatedModelFqnToControllerMap = [
+        RelatedBaseModelChild::class => RelatedResourceControllerTraitIncludedChild::class,
+    ];
+````
+
 For model properties autocomplete:
 
 - extend BaseModelAttributes following the same FQN structure as the parent's:
@@ -141,6 +149,10 @@ Register the crud routes in your application using (for example in Laravel)
             Route::get('/' . $resource . '/{identifier}', [$controller, 'get'])->name('apiinfo.get_' . $resource);
             Route::delete('/' . $resource . '/{identifier}', [$controller, 'delete'])->name('apiinfo.delete_' . $resource);
             // Route::match(['post', 'get'], '/' . $resource . '/{identifier}/{relation}', [$controller, 'listRelation']); // paid version only
+            Route::get('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [$controller, 'getRelated']);
+            Route::put('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [$controller, 'updateRelated']);
+            Route::delete('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [$controller, 'deleteRelated']);
+
         }
     } catch (Throwable $e) {
         \Illuminate\Support\Facades\Log::error($e->getMessage());
@@ -191,6 +203,19 @@ for example for lumen:
                 'as' => $resource . '.delete',
                 'uses' => $controller . '@delete',
             ]);
+
+            $router->get('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [
+                'as' => $resource . '.getRelated',
+                'uses' => $controller . '@getRelated',
+            ]);
+            $router->put('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [
+                'as' => $resource . '.updateRelated',
+                'uses' => $controller . '@updateRelated',
+            ]);
+            $router->delete('/' . $resource . '/{identifier}/{relation}/{relatedIdentifier}', [
+                'as' => $resource . '.deleteRelated',
+                'uses' => $controller . '@deleteRelated',
+            ]);
         }
     } catch (Throwable $e) {
         \Illuminate\Support\Facades\Log::error($e->getMessage());
@@ -256,6 +281,8 @@ The above "errors" are optional and appear only for validation errors while "mes
 #### III.2 Get resource
 **GET** /{resource}/{identifier}?withRelations[]=has_manyRelation&withRelations[]=has_oneRelation&withRelationsCount[]=has_manyRelation&withRelationsExistence[]=has_manyRelation
 
+**GET** /{resource}/{identifier}/{relation}/{relatedIdentifier}?withRelations[]=has_manyRelation&withRelations[]=has_oneRelation&withRelationsCount[]=has_manyRelation&withRelationsExistence[]=has_manyRelation
+
 headers:
 
       Authorization: Bearer ... // if needed. not coded in this lib
@@ -411,6 +438,8 @@ Obs.
 #### III.4 Update resource (or create)
 **PUT** /{resource}/{identifier}
 
+**PUT** /{resource}/{identifier}/{resource}/{relatedIdentifier}
+
 headers:
 
       Authorization: Bearer ... // if needed. not coded in this lib
@@ -461,6 +490,8 @@ Update will validate only dirty columns, not all sent columns, meaning the updat
 #### III.5 Delete resource
 **DELETE** /{resource}/{identifier}
 
+**DELETE** /{resource}/{identifier}/{resource}/{relatedIdentifier}
+
 headers:
 
       Authorization: Bearer ... // if needed. not coded in this lib
diff --git a/src/Http/Controllers/ResourceControllerTrait.php b/src/Http/Controllers/ResourceControllerTrait.php
@@ -29,6 +29,12 @@ trait ResourceControllerTrait
     protected string $label = '';
     protected bool $simplePaginate = false;
     protected array $modelFqnToControllerMap = [];
+
+    /**
+     * If a related resource is not exposed via crud in $modelFqnToControllerMap,
+     *     it can be exposed in this property
+     */
+    protected array $relatedModelFqnToControllerMap = [];
     protected ResourceServiceInterface $resourceService;
     protected array $paginationKeys = [
         'current_page',
@@ -213,6 +219,16 @@ protected function getFilteredRelations(array $relations, ?BaseModel $baseModel
             $this->getResourceAsModelFQN())::WITH_RELATIONS, $relations);
     }
 
+    /**
+     * @throws \Exception
+     */
+    protected function validateRelation(string $relation): void
+    {
+        if (!\in_array($relation, $this->getResourceAsModelFQN()::WITH_RELATIONS, true)) {
+            throw new \Exception('Relation as subresource not found for this resource.');
+        }
+    }
+
     protected function handleList(array $allRequest, Request $request): Response
     {
         try {
@@ -240,6 +256,74 @@ protected function handleList(array $allRequest, Request $request): Response
         }
     }
 
+    public function getRelated(
+        Request $request,
+        string $identifier,
+        string $relation,
+        string $relatedIdentifier
+    ): JsonResponse {
+        try {
+            return $this->getRelatedController(
+                $this->getRelatedFromRelation($identifier, $relation, $relatedIdentifier),
+                $relation
+            )->get($relatedIdentifier, $request);
+        } catch (\Throwable $e) {
+            if (!$e instanceof ModelNotFoundException) {
+                Log::error($this->label . '/' . $identifier . '/' . $relation . '/'. $relatedIdentifier .
+                    ', error = ' . $e->getMessage());
+            }
+
+            return GeneralHelper::app(JsonResponse::class, [
+                'data' => ['message' => GeneralHelper::getSafeErrorMessage($e)],
+                'status' => 400
+            ]);
+        }
+    }
+
+    public function updateRelated(
+        Request $request,
+        string $identifier,
+        string $relation,
+        string $relatedIdentifier
+    ): JsonResponse {
+        try {
+            return $this->getRelatedController(
+                $this->getRelatedFromRelation($identifier, $relation, $relatedIdentifier),
+                $relation
+            )->update($relatedIdentifier, $request);
+        } catch (\Throwable $e) {
+            if (!$e instanceof ModelNotFoundException) {
+                Log::error($this->label . '/' . $identifier . '/' . $relation . '/'. $relatedIdentifier .
+                    ', error = ' . $e->getMessage());
+            }
+
+            return GeneralHelper::app(JsonResponse::class, [
+                'data' => ['message' => GeneralHelper::getSafeErrorMessage($e)],
+                'status' => 400
+            ]);
+        }
+    }
+
+    public function deleteRelated(string $identifier, string $relation, string $relatedIdentifier): JsonResponse
+    {
+        try {
+            return $this->getRelatedController(
+                $this->getRelatedFromRelation($identifier, $relation, $relatedIdentifier),
+                $relation
+            )->delete($relatedIdentifier);
+        } catch (\Throwable $e) {
+            if (!$e instanceof ModelNotFoundException) {
+                Log::error($this->label . '/' . $identifier . '/' . $relation . '/'. $relatedIdentifier .
+                    ', error = ' . $e->getMessage());
+            }
+
+            return GeneralHelper::app(JsonResponse::class, [
+                'data' => ['message' => GeneralHelper::getSafeErrorMessage($e)],
+                'status' => 400
+            ]);
+        }
+    }
+
     /**
      * @throws \Exception
      */
@@ -255,7 +339,6 @@ protected function getResourceAsModelFQN(): string
         throw new \Exception('Could not getResourceAsModelFQN.');
     }
 
-
     protected function getEmptyPaginatedResponse(array $request): JsonResponse
     {
         $data = [
@@ -379,4 +462,56 @@ protected function throwIfForbidden(bool $condition): void
             throw new \Exception('Forbidden');
         }
     }
+
+    /**
+     * @return self
+     * @throws \Throwable
+     */
+    protected function getRelatedController(BaseModel $related, string $relation): object
+    {
+        $controllerFqn = (string)($this->modelFqnToControllerMap[$related::class] ??
+            ($this->relatedModelFqnToControllerMap[$related::class] ?? ''));
+
+        if ('' === $controllerFqn) {
+            throw new \Exception('Related ' . $relation . ' not exposed as resource.');
+        }
+
+        return GeneralHelper::app($controllerFqn);
+    }
+
+    /**
+     * @throws \Throwable
+     */
+    protected function getRelatedFromRelation(
+        string $identifier,
+        string $relation,
+        string $relatedIdentifier
+    ): BaseModel {
+        $this->validateRelation($relation);
+        /** @var Relation $relationInstance */
+        $relationInstance = $this->resourceService->get($identifier, appendIndex: false)->{$relation}();
+        /** @var BaseModel $related */
+        $related = $relationInstance->getRelated();
+        $exploded = \explode($related::COMPOSITE_PK_SEPARATOR, $relatedIdentifier);
+        $pks = [];
+
+        foreach ($related->getPrimaryKeyFilter() as $column => $value) {
+            if (!\is_array($value) && \is_string($column)) {
+                $pks[] = $column;
+
+                continue;
+            }
+
+            $pks[] = \reset($value);
+        }
+
+        if (
+            \count($pks) !== \count($exploded)
+            || !$relationInstance->where(\array_combine($pks, $exploded))->exists()
+        ) {
+            throw (new ModelNotFoundException())->setModel($related::class);
+        }
+
+        return $related;
+    }
 }
