Basic start of the LogsChanges trait (for administrative changes)

Author: uberbrady

app/Models/Category.php

@@ -11,6 +11,7 @@
 use Watson\Validating\ValidatingTrait;
 use App\Helpers\Helper;
 use Illuminate\Support\Str;
+use App\Models\Traits\LogsChanges;
 
 /**
  * Model for Categories. Categories are a higher-level group
@@ -27,6 +28,7 @@ class Category extends SnipeModel
     protected $presenter = \App\Presenters\CategoryPresenter::class;
     use Presentable;
     use SoftDeletes;
+    use LogsChanges;
 
     protected $table = 'categories';
     protected $hidden = ['created_by', 'deleted_at'];

app/Models/Traits/LogsChanges.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace App\Models\Traits;
+
+use App\Enums\ActionType;
+use App\Models\Actionlog;
+trait LogsChanges {
+
+    private ?ActionType $action_type = null;
+    private array $meta = [];
+    static function bootLogsChanges() {
+        static::creating(function ($model) {
+            \Log::error("CREATING!");
+            $model->action_type = ActionType::Create;
+        });
+
+        static::updating(function ($model) {
+            \Log::error("UPDATING!");
+            if(!$model->action_type) {
+                \Log::error("No action type - so definitely doing 'update'!");
+                $model->action_type = ActionType::Update;
+            }
+        });
+
+        static::restoring(function ($model) {
+            $model->action_type = ActionType::Restore;
+        });
+
+        /* The main functionality is here: */
+        static::saving(function ($model) {
+            \Log::error("recording changes.......");
+            $model->record_changes();
+        });
+
+        static::saved(function ($model) {
+            \Log::error("SAVED!!!!");
+            $model->add_action_log();
+        });
+
+        static::deleted(function ($model) {
+            $model->action_type = ActionType::Delete;
+            $model->add_action_log();
+            \Log::error("deleted!!!!!!!!!!!");
+        });
+    }
+
+    function record_changes()
+    {
+        $changed = [];
+
+        // something here with custom fields is needed? or will getRawOriginal et al just do that for us?
+        foreach ($this->getRawOriginal() as $key => $value) { //on 'create' this doesn't write down the new attributes
+            if ($this->getRawOriginal()[$key] != $this->getAttributes()[$key]) {
+                $changed[$key]['old'] = $this->getRawOriginal()[$key];
+                $changed[$key]['new'] = $this->getAttributes()[$key];
+
+                if (property_exists($this, 'hidden') && in_array($key, $this->hidden)) {
+                    $changed[$key]['old'] = '*************'; //FIXME deleted_at is hidden?!
+                    $changed[$key]['new'] = '*************';
+                }
+            }
+        }
+        $this->meta = $changed;
+    }
+
+    function add_action_log()
+    {
+        if(!$this->action_type && !$this->meta) {
+            \Log::warning("No action type set, and no changes to record. Not logging.");
+            return;
+        }
+        if($this->action_type == ActionType::Update && !$this->meta) {
+            \Log::warning("An update with no actual changes to record. Not logging");
+            return;
+        }
+        $logAction = new Actionlog();
+        $logAction->action_type = $this->action_type->value;
+        $logAction->item()->associate($this);
+        $logAction->created_at = date('Y-m-d H:i:s');
+        $logAction->action_date = date('Y-m-d H:i:s');
+        // target_id and target_type?
+        // need IP and user-agent!!!!!
+        $logAction->created_by = auth()->id();
+        $logAction->log_meta = json_encode($this->meta); // this gets weird on 'create'
+        if($logAction->save()) {
+            //success! Reset for more actions later...
+            $this->action_type = null;
+            $this->meta = [];
+        }
+    }
+}