Merge pull request #77 from Lomkit/feature/hooks

feature/hooks

Author: GautierDele

README.md

@@ -79,6 +79,7 @@ Here is a quick look at what you can do using API search method:
             ]
           }
         ],
+        "gates": ["create", "view"],
         "page": 2,
         "limit": 10
     }

config/rest.php

@@ -4,15 +4,15 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Rest Automatic Gates
+    | Rest Gates
     |--------------------------------------------------------------------------
     |
     | The following configuration option contains gates customisation. You might
     | want to adapt this feature to your needs.
     |
     */
 
-    'automatic_gates' => [
+    'gates' => [
         'enabled' => true,
         'key'     => 'gates',
         // Here you can customize the keys for each gate

src/Concerns/PerformsRestOperations.php

@@ -5,7 +5,7 @@
 use Illuminate\Support\Facades\DB;
 use Lomkit\Rest\Contracts\QueryBuilder;
 use Lomkit\Rest\Http\Requests\DestroyRequest;
-use Lomkit\Rest\Http\Requests\DetailRequest;
+use Lomkit\Rest\Http\Requests\DetailsRequest;
 use Lomkit\Rest\Http\Requests\ForceDestroyRequest;
 use Lomkit\Rest\Http\Requests\MutateRequest;
 use Lomkit\Rest\Http\Requests\OperateRequest;
@@ -17,14 +17,16 @@ trait PerformsRestOperations
     /**
      * Retrieve details of a resource.
      *
-     * @param DetailRequest $request
+     * @param DetailsRequest $request
      *
      * @return array
      */
-    public function details(DetailRequest $request)
+    public function details(DetailsRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeDetails($request);
+
         $resource->authorizeTo('viewAny', $resource::$model);
 
         return [
@@ -43,13 +45,19 @@ public function search(SearchRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeSearch($request);
+
         $query = app()->make(QueryBuilder::class, ['resource' => $resource, 'query' => null])
             ->search($request->input('search', []));
 
+        $responsable = $resource->paginate($query, $request);
+
+        $this->afterSearch($request);
+
         return $resource::newResponse()
             ->resource($resource)
             ->responsable(
-                $resource->paginate($query, $request)
+                $responsable
             );
     }
 
@@ -64,6 +72,8 @@ public function mutate(MutateRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeMutate($request);
+
         DB::beginTransaction();
 
         $operations = app()->make(QueryBuilder::class, ['resource' => $resource, 'query' => null])
@@ -74,6 +84,8 @@ public function mutate(MutateRequest $request)
 
         DB::commit();
 
+        $this->afterMutate($request);
+
         return $operations;
     }
 
@@ -89,10 +101,14 @@ public function operate(OperateRequest $request, $action)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeOperate($request);
+
         $actionInstance = $resource->action($request, $action);
 
         $modelsImpacted = $actionInstance->handleRequest($request);
 
+        $this->afterOperate($request);
+
         return response([
             'data' => [
                 'impacted' => $modelsImpacted,
@@ -111,6 +127,8 @@ public function destroy(DestroyRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeDestroy($request);
+
         $query = $resource->destroyQuery($request, $resource::newModel()::query());
 
         $models = $query
@@ -120,9 +138,15 @@ public function destroy(DestroyRequest $request)
         foreach ($models as $model) {
             self::newResource()->authorizeTo('delete', $model);
 
+            $resource->destroying($request, $model);
+
             $resource->performDelete($request, $model);
+
+            $resource->destroyed($request, $model);
         }
 
+        $this->afterDestroy($request);
+
         return $resource::newResponse()
             ->resource($resource)
             ->responsable($models);
@@ -139,6 +163,8 @@ public function restore(RestoreRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeRestore($request);
+
         $query = $resource->restoreQuery($request, $resource::newModel()::query());
 
         $models = $query
@@ -149,14 +175,21 @@ public function restore(RestoreRequest $request)
         foreach ($models as $model) {
             self::newResource()->authorizeTo('restore', $model);
 
+            $resource->restoring($request, $model);
+
             $resource->performRestore($request, $model);
+
+            $resource->restored($request, $model);
         }
 
+        $this->afterRestore($request);
+
         return $resource::newResponse()
             ->resource($resource)
             ->responsable($models);
     }
 
+    // @TODO: in version upgrade, rename "forceDelete" to "forceDestroy" generally
     /**
      * Force delete resources based on the given request.
      *
@@ -168,6 +201,8 @@ public function forceDelete(ForceDestroyRequest $request)
     {
         $request->resource($resource = static::newResource());
 
+        $this->beforeForceDestroy($request);
+
         $query = $resource->forceDeleteQuery($request, $resource::newModel()::query());
 
         $models = $query
@@ -178,9 +213,15 @@ public function forceDelete(ForceDestroyRequest $request)
         foreach ($models as $model) {
             self::newResource()->authorizeTo('forceDelete', $model);
 
+            $resource->forceDestroying($request, $model);
+
             $resource->performForceDelete($request, $model);
+
+            $resource->forceDestroyed($request, $model);
         }
 
+        $this->afterForceDestroy($request);
+
         return $resource::newResponse()
             ->resource($resource)
             ->responsable($models);

src/Concerns/Resource/DisableAutomaticGates.php renamed to src/Concerns/Resource/DisableGates.php

@@ -2,14 +2,14 @@
 
 namespace Lomkit\Rest\Concerns\Resource;
 
-trait DisableAutomaticGates
+trait DisableGates
 {
     /**
-     * Check if automatic gating is enabled.
+     * Check if gating is enabled.
      *
      * @return bool
      */
-    public function isAutomaticGatingEnabled(): bool
+    public function isGatingEnabled(): bool
     {
         return false;
     }

src/Concerns/Resource/HasResourceHooks.php

@@ -0,0 +1,118 @@
+<?php
+
+namespace Lomkit\Rest\Concerns\Resource;
+
+use Illuminate\Database\Eloquent\Model;
+use Lomkit\Rest\Http\Requests\DestroyRequest;
+use Lomkit\Rest\Http\Requests\ForceDestroyRequest;
+use Lomkit\Rest\Http\Requests\MutateRequest;
+use Lomkit\Rest\Http\Requests\RestoreRequest;
+
+trait HasResourceHooks
+{
+    /**
+     * Executed when a model has been "mutating".
+     *
+     * @param MutateRequest $request
+     * @param array         $requestBody
+     * @param Model         $model
+     *
+     * @return void
+     */
+    public function mutating(MutateRequest $request, array $requestBody, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "mutated".
+     *
+     * @param MutateRequest $request
+     * @param array         $requestBody
+     * @param Model         $model
+     *
+     * @return void
+     */
+    public function mutated(MutateRequest $request, array $requestBody, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "destroying".
+     *
+     * @param DestroyRequest $request
+     * @param Model          $model
+     *
+     * @return void
+     */
+    public function destroying(DestroyRequest $request, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "destroyed".
+     *
+     * @param DestroyRequest $request
+     * @param Model          $model
+     *
+     * @return void
+     */
+    public function destroyed(DestroyRequest $request, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "restoring".
+     *
+     * @param RestoreRequest $request
+     * @param Model          $model
+     *
+     * @return void
+     */
+    public function restoring(RestoreRequest $request, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "restored".
+     *
+     * @param RestoreRequest $request
+     * @param Model          $model
+     *
+     * @return void
+     */
+    public function restored(RestoreRequest $request, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "forceDestroying".
+     *
+     * @param ForceDestroyRequest $request
+     * @param Model               $model
+     *
+     * @return void
+     */
+    public function forceDestroying(ForceDestroyRequest $request, Model $model): void
+    {
+        //
+    }
+
+    /**
+     * Executed when a model has been "forceDestroyed".
+     *
+     * @param ForceDestroyRequest $request
+     * @param Model               $model
+     *
+     * @return void
+     */
+    public function forceDestroyed(ForceDestroyRequest $request, Model $model): void
+    {
+        //
+    }
+}

src/Http/Controllers/Controller.php

@@ -4,12 +4,14 @@
 
 use Lomkit\Rest\Concerns\PerformsRestOperations;
 use Lomkit\Rest\Http\Controllers\Traits\ExtendsDocumentationOperations;
+use Lomkit\Rest\Http\Controllers\Traits\HasControllerHooks;
 use Lomkit\Rest\Http\Resource;
 
 abstract class Controller extends \Illuminate\Routing\Controller
 {
     use PerformsRestOperations;
     use ExtendsDocumentationOperations;
+    use HasControllerHooks;
 
     /**
      * The resource the entry corresponds to.