[Refactor] Pass resource into Eloquent controller hooks

The resource provided by the client is now passed down through
the Eloquent controller hooks - saving, saved, creating, created,
updating and updated.

In addition all the Eloquent hooks have been deleted from the
class, and `method_exists` is used instead. This allows a
controller class to type-hint the arguments however it needs,
plus it can optionally include the second argument (resource)
if needed.

Author: lindyhopchris

UPGRADE.md

@@ -205,6 +205,16 @@ public function read(JsonApiRequest $request) {}
 Use the request object to get the resource id, relationship name and document (the JSON API request content). Refer
 to the interface for methods available.
 
+#### Eloquent Hooks
+
+The `saving`, `saved`, `creating`, `created`, `updating`, `updated` method hooks now receive the resource provided
+by the client as the second method argument. (This object passed implements 
+`CloudCreativity\JsonApi\Contracts\Object\ResourceInterface`.)
+
+In addition, these methods are no longer implemented in the parent class. This means you can use whatever method
+signature you want, including type-hinting the first argument as the specific class of model that is being handled by
+the controller.
+
 #### Search All
 
 You now need to always inject a search object into the Eloquent controller, otherwise the controller will return a 

src/Http/Controllers/EloquentController.php

@@ -247,12 +247,12 @@ protected function commit(Model $model, ResourceInterface $resource)
     {
         $isUpdating = $model->exists;
 
-        $this->beforeCommit($model, $isUpdating);
+        $this->beforeCommit($model, $resource, $isUpdating);
 
         $result = $this->save($model, $resource);
 
         if ($result) {
-            $this->afterCommit($model, $isUpdating);
+            $this->afterCommit($model, $resource, $isUpdating);
         }
 
         return $result;
@@ -310,34 +310,44 @@ protected function saveRelated($related)
      * Determines which callback to use before creating or updating a model.
      *
      * @param Model $model
+     * @param ResourceInterface $resource
      * @param bool $isUpdating
      */
-    protected function beforeCommit(Model $model, $isUpdating)
+    protected function beforeCommit(Model $model, ResourceInterface $resource, $isUpdating)
     {
-        $this->saving($model);
+        /** Trigger the saving hook if it is implemented */
+        if (method_exists($this, 'saving')) {
+            $this->saving($model, $resource);
+        }
+
+        $fn = $isUpdating ? 'updating' : 'creating';
 
-        if ($isUpdating) {
-            $this->updating($model);
-        } else {
-            $this->creating($model);
+        /** Trigger the updating or creating hook if it is implemented */
+        if (method_exists($this, $fn)) {
+            call_user_func([$this, $fn], $model, $resource);
         }
     }
 
     /**
      * Determines which callback to use after a model is updated or created.
      *
      * @param Model $model
+     * @param ResourceInterface $resource
      * @param bool $isUpdating
      */
-    protected function afterCommit(Model $model, $isUpdating)
+    protected function afterCommit(Model $model, ResourceInterface $resource, $isUpdating)
     {
-        if ($isUpdating) {
-            $this->updated($model);
-        } else {
-            $this->created($model);
+        $fn = $isUpdating ? 'updated' : 'created';
+
+        /** Trigger the updated or created hook if it is implemented */
+        if (method_exists($this, $fn)) {
+            call_user_func([$this, $fn], $model, $resource);
         }
 
-        $this->saved($model);
+        /** Trigger the saved hook if it is implemented */
+        if (method_exists($this, 'saved')) {
+            $this->saved($model, $resource);
+        }
     }
 
     /**
@@ -348,11 +358,15 @@ protected function afterCommit(Model $model, $isUpdating)
      */
     protected function destroy(Model $model)
     {
-        $this->deleting($model);
+        /** Trigger the deleting hook if it is implemented */
+        if (method_exists($this, 'deleting')) {
+            $this->deleting($model);
+        }
 
         $result = (bool) $model->delete();
 
-        if ($result) {
+        /** Trigger the deleted hook if it is implemented and delete was successful */
+        if ($result && method_exists($this, 'deleted')) {
             $this->deleted($model);
         }
 
@@ -451,91 +465,4 @@ private function doDestroy(Model $model)
         });
     }
 
-    /**
-     * Called before the model is saved (either creating or updating an existing model).
-     *
-     * Child classes can overload this method if they need to do any logic pre-save.
-     *
-     * @param Model $model
-     */
-    protected function saving(Model $model)
-    {
-    }
-
-    /**
-     * Called after the model has been saved (when a model has been created or updated)
-     *
-     * Child classes can overload this method if they need to do any logic post-save.
-     *
-     * @param Model $model
-     */
-    protected function saved(Model $model)
-    {
-    }
-
-    /**
-     * Called before the model is created.
-     *
-     * Child classes can overload this method if they need to do any logic pre-creation.
-     *
-     * @param Model $model
-     */
-    protected function creating(Model $model)
-    {
-    }
-
-    /**
-     * Called after the model has been created.
-     *
-     * Child classes can overload this method if they need to do any logic post-creation.
-     *
-     * @param Model $model
-     */
-    protected function created(Model $model)
-    {
-    }
-
-    /**
-     * Called before the model is updated.
-     *
-     * Child classes can overload this method if they need to do any logic pre-updating.
-     *
-     * @param Model $model
-     */
-    protected function updating(Model $model)
-    {
-    }
-
-    /**
-     * Called after the model has been updated.
-     *
-     * Child classes can overload this method if they need to do any logic post-updating.
-     *
-     * @param Model $model
-     */
-    protected function updated(Model $model)
-    {
-    }
-
-    /**
-     * Called before the model is destroyed.
-     *
-     * Child classes can overload this method if they need to do any logic pre-delete.
-     *
-     * @param Model $model
-     */
-    protected function deleting(Model $model)
-    {
-    }
-
-    /**
-     * Called after the model has been destroyed.
-     *
-     * Child classes can overload this method if they need to do any logic post-delete.
-     *
-     * @param Model $model
-     */
-    protected function deleted(Model $model)
-    {
-    }
 }