refactor: standardize beforeSave, beforeStore & beforeUpdate hook signatures on relation resource controllers

Author: alexzarbn

src/Concerns/HandlesRelationStandardOperations.php

@@ -69,11 +69,6 @@ public function index(Request $request, $parentKey)
      */
     public function store(Request $request, $parentKey)
     {
-        $beforeHookResult = $this->beforeStore($request);
-        if ($this->hookResponds($beforeHookResult)) {
-            return $beforeHookResult;
-        }
-
         $resourceModelClass = $this->resolveResourceModelClass();
 
         if ($this->authorizationRequired()) {
@@ -89,6 +84,11 @@ public function store(Request $request, $parentKey)
         $entity = new $resourceModelClass;
         $entity->fill($request->only($entity->getFillable()));
 
+        $beforeHookResult = $this->beforeStore($request, $entity);
+        if ($this->hookResponds($beforeHookResult)) {
+            return $beforeHookResult;
+        }
+
         $beforeSaveHookResult = $this->beforeSave($request, $entity);
         if ($this->hookResponds($beforeSaveHookResult)) {
             return $beforeSaveHookResult;
@@ -179,11 +179,6 @@ public function show(Request $request, $parentKey, $relatedKey = null)
      */
     public function update(Request $request, $parentKey, $relatedKey = null)
     {
-        $beforeHookResult = $this->beforeUpdate($request, $relatedKey);
-        if ($this->hookResponds($beforeHookResult)) {
-            return $beforeHookResult;
-        }
-
         $parentEntity = $this->queryBuilder->buildQuery($this->newModelQuery(), $request)
             ->findOrFail($parentKey);
 
@@ -203,6 +198,11 @@ public function update(Request $request, $parentKey, $relatedKey = null)
 
         $entity->fill($request->only($entity->getFillable()));
 
+        $beforeHookResult = $this->beforeUpdate($request, $entity);
+        if ($this->hookResponds($beforeHookResult)) {
+            return $beforeHookResult;
+        }
+
         $beforeSaveHookResult = $this->beforeSave($request, $entity);
         if ($this->hookResponds($beforeSaveHookResult)) {
             return $beforeSaveHookResult;
@@ -247,11 +247,6 @@ public function update(Request $request, $parentKey, $relatedKey = null)
      */
     public function destroy(Request $request, $parentKey, $relatedKey = null)
     {
-        $beforeHookResult = $this->beforeDestroy($request, $relatedKey);
-        if ($this->hookResponds($beforeHookResult)) {
-            return $beforeHookResult;
-        }
-
         $parentEntity = $this->queryBuilder->buildQuery($this->newModelQuery(), $request)
             ->findOrFail($parentKey);
 
@@ -276,6 +271,11 @@ public function destroy(Request $request, $parentKey, $relatedKey = null)
             $this->authorize($forceDeletes ? 'forceDelete' : 'delete', $entity);
         }
 
+        $beforeHookResult = $this->beforeDestroy($request, $entity);
+        if ($this->hookResponds($beforeHookResult)) {
+            return $beforeHookResult;
+        }
+
         if (!$forceDeletes) {
             $entity->delete();
         } else {
@@ -306,11 +306,6 @@ public function destroy(Request $request, $parentKey, $relatedKey = null)
      */
     public function restore(Request $request, $parentKey, $relatedKey = null)
     {
-        $beforeHookResult = $this->beforeRestore($request, $relatedKey);
-        if ($this->hookResponds($beforeHookResult)) {
-            return $beforeHookResult;
-        }
-
         $parentEntity = $this->queryBuilder->buildQuery($this->newModelQuery(), $request)
             ->findOrFail($parentKey);
 
@@ -329,6 +324,11 @@ public function restore(Request $request, $parentKey, $relatedKey = null)
             $this->authorize('restore', $entity);
         }
 
+        $beforeHookResult = $this->beforeRestore($request, $entity);
+        if ($this->hookResponds($beforeHookResult)) {
+            return $beforeHookResult;
+        }
+
         $entity->restore();
 
         $entity = $this->cleanupEntity($entity);
@@ -410,9 +410,10 @@ protected function afterIndex(Request $request, Paginator $entities)
      * The hook is executed before creating new relation resource.
      *
      * @param Request $request
+     * @param Model $entity
      * @return mixed
      */
-    protected function beforeStore(Request $request)
+    protected function beforeStore(Request $request, $entity)
     {
         return null;
     }
@@ -457,10 +458,10 @@ protected function afterShow(Request $request, $entity)
      * The hook is executed before updating a relation resource.
      *
      * @param Request $request
-     * @param int|string|null $key
+     * @param Model $entity
      * @return mixed
      */
-    protected function beforeUpdate(Request $request, $key)
+    protected function beforeUpdate(Request $request, $entity)
     {
         return null;
     }
@@ -481,10 +482,10 @@ protected function afterUpdate(Request $request, $entity)
      * The hook is executed before deleting a relation resource.
      *
      * @param Request $request
-     * @param int|string|null $key
+     * @param Model $entity
      * @return mixed
      */
-    protected function beforeDestroy(Request $request, $key)
+    protected function beforeDestroy(Request $request, $entity)
     {
         return null;
     }
@@ -505,10 +506,10 @@ protected function afterDestroy(Request $request, $entity)
      * The hook is executed before restoring a relation resource.
      *
      * @param Request $request
-     * @param int|string|null $key
+     * @param Model $entity
      * @return mixed
      */
-    protected function beforeRestore(Request $request, $key)
+    protected function beforeRestore(Request $request, $entity)
     {
         return null;
     }