Merge pull request #131 from horstoeko/beforefresh

feat: before*Fresh hook

src/Concerns/HandlesStandardBatchOperations.php

@@ -62,6 +62,8 @@ protected function batchStoreWithTransaction(Request $request)
 
             $this->performStore($request, $entity, $resource);
 
+            $this->beforeStoreFresh($request, $entity);
+
             $entity = $entity->fresh($requestedRelations);
             $entity->wasRecentlyCreated = true;
 
@@ -153,6 +155,8 @@ protected function batchUpdateWithTransaction(Request $request)
                 $request->input("resources.{$entity->{$this->keyName()}}")
             );
 
+            $this->beforeUpdateFresh($request, $entity);
+
             $entity = $entity->fresh($requestedRelations);
 
             $this->afterSave($request, $entity);
@@ -296,6 +300,7 @@ protected function batchDestroyWithTransaction(Request $request)
             if (!$forceDeletes) {
                 $this->performDestroy($entity);
                 if ($softDeletes) {
+                    $this->beforeDestroyFresh($request, $entity);
                     $entity = $entity->fresh($requestedRelations);
                 }
             } else {
@@ -414,6 +419,8 @@ protected function batchRestoreWithTransaction(Request $request)
 
             $this->performRestore($entity);
 
+            $this->beforeRestoreFresh($request, $entity);
+
             $entity = $entity->fresh($requestedRelations);
 
             $this->afterRestore($request, $entity);

src/Concerns/HandlesStandardOperations.php

@@ -174,6 +174,11 @@ protected function storeWithTransaction(Request $request)
             $request->all()
         );
 
+        $beforeStoreFreshResult = $this->beforeStoreFresh($request, $entity);
+        if ($this->hookResponds($beforeStoreFreshResult)) {
+            return $beforeStoreFreshResult;
+        }
+
         $entity = $entity->fresh($requestedRelations);
         $entity->wasRecentlyCreated = true;
 
@@ -229,6 +234,18 @@ protected function performStore(Request $request, Model $entity, array $attribut
         $entity->save();
     }
 
+    /**
+     * The hook is executed after creating and before refreshing the resource.
+     *
+     * @param Request $request
+     * @param Model $entity
+     * @return mixed
+     */
+    protected function beforeStoreFresh(Request $request, Model $entity)
+    {
+        return null;
+    }
+
     /**
      * The hook is executed after creating or updating a resource.
      *
@@ -398,6 +415,11 @@ protected function updateWithTransaction(Request $request, $key)
             $request->all()
         );
 
+        $beforeUpdateFreshResult = $this->beforeUpdateFresh($request, $entity);
+        if ($this->hookResponds($beforeUpdateFreshResult)) {
+            return $beforeUpdateFreshResult;
+        }
+
         $entity = $entity->fresh($requestedRelations);
 
         $afterSaveHookResult = $this->afterSave($request, $entity);
@@ -465,6 +487,18 @@ protected function performUpdate(Request $request, Model $entity, array $attribu
         $entity->save();
     }
 
+    /**
+     * The hook is executed after updating and before refreshing the resource.
+     *
+     * @param Request $request
+     * @param Model $entity
+     * @return mixed
+     */
+    protected function beforeUpdateFresh(Request $request, Model $entity)
+    {
+        return null;
+    }
+
     /**
      * The hook is executed after updating a resource.
      *
@@ -529,6 +563,11 @@ protected function destroyWithTransaction(Request $request, $key)
         if (!$forceDeletes) {
             $this->performDestroy($entity);
             if ($softDeletes) {
+                $beforeDestroyFreshResult = $this->beforeDestroyFresh($request, $entity);
+                if ($this->hookResponds($beforeDestroyFreshResult)) {
+                    return $beforeDestroyFreshResult;
+                }
+
                 $entity = $entity->fresh($requestedRelations);
             }
         } else {
@@ -610,6 +649,19 @@ protected function performForceDestroy(Model $entity): void
         $entity->forceDelete();
     }
 
+    /**
+     * The hook is executed after deleting and before refreshing the resource.
+     * This hook is only called when not using forced deletes
+     *
+     * @param Request $request
+     * @param Model $entity
+     * @return mixed
+     */
+    protected function beforeDestroyFresh(Request $request, Model $entity)
+    {
+        return null;
+    }
+
     /**
      * The hook is executed after deleting a resource.
      *
@@ -666,6 +718,11 @@ protected function restoreWithTransaction(Request $request, $key)
 
         $this->performRestore($entity);
 
+        $beforeHookResult = $this->beforeRestoreFresh($request, $entity);
+        if ($this->hookResponds($beforeHookResult)) {
+            return $beforeHookResult;
+        }
+
         $entity = $entity->fresh($requestedRelations);
 
         $afterHookResult = $this->afterRestore($request, $entity);
@@ -726,6 +783,19 @@ protected function performRestore(Model $entity): void
         $entity->restore();
     }
 
+    /**
+     * The hook is executed after force restoring a previously deleted resource but before
+     * refreshing the resource.
+     *
+     * @param Request $request
+     * @param Model $entity
+     * @return mixed
+     */
+    protected function beforeRestoreFresh(Request $request, Model $entity)
+    {
+        return null;
+    }
+
     /**
      * The hook is executed after force restoring a previously deleted resource.
      *