Trigger an event before saving an activity

Author: erikgaal

src/Concerns/LogsActivity.php

@@ -5,8 +5,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Config;
+use Scrn\Journal\Events\ActivityPrepared;
 use Scrn\Journal\Models\Activity;
 
 trait LogsActivity
@@ -37,7 +36,9 @@ protected static function bootLogsActivity()
 
                 list($old_data, $new_data) = method_exists($model, $attributeGetter) ? $model->$attributeGetter(...func_get_args()) : null;
 
-                $model->transformActivity(journal()->action($event)->on($model)->data($old_data, $new_data)->toActivity())->save();
+                $activity = $model->transformActivity(journal()->action($event)->on($model)->data($old_data, $new_data)->toActivity());
+
+                event(new ActivityPrepared($activity));
             });
         }
     }
@@ -51,7 +52,7 @@ public function getCreatedEventAttributes(): array
     {
         $attributes = [];
 
-        foreach ($this->attributes as $attribute => $value) {
+        foreach ($this->getAttributes() as $attribute => $value) {
             if ($this->shouldAttributeBeLogged($attribute)) {
                 $attributes[$attribute] = $value;
             }
@@ -73,7 +74,7 @@ public function getUpdatedEventAttributes(): array
         $old = [];
         $new = [];
 
-        foreach (array_merge($this->getDirty(), $this->getChanges()) as $attribute => $value) {
+        foreach ($this->getDirty() as $attribute => $value) {
             if ($this->shouldAttributeBeLogged($attribute)) {
                 $old[$attribute] = $this->getOriginal($attribute);
                 $new[$attribute] = $this->getAttribute($attribute);
@@ -95,7 +96,7 @@ public function getDeletedEventAttributes(): array
     {
         $attributes = [];
 
-        foreach ($this->attributes as $attribute => $value) {
+        foreach ($this->getAttributes() as $attribute => $value) {
             if ($this->shouldAttributeBeLogged($attribute)) {
                 $attributes[$attribute] = $value;
             }
@@ -124,7 +125,7 @@ public function getRestoredEventAttributes(): array
      */
     public function getLoggedEvents(): array
     {
-        $events = Config::get('journal.events', ['created', 'updated', 'deleted']);
+        $events = config()->get('journal.events', ['created', 'updated', 'deleted']);
 
         if (in_array(SoftDeletes::class, class_uses_recursive(static::class))) {
             $events[] = 'restored';
@@ -134,9 +135,7 @@ public function getLoggedEvents(): array
             $events = array_merge($events, ['pivotAttached', 'pivotDetached', 'pivotUpdated']);
         }
 
-        if (isset($this->logged)) {
-            $events = array_merge($events, $this->logged ?? []);
-        }
+        $events = array_merge($events, $this->logged ?? []);
 
         return $events;
     }
@@ -185,7 +184,7 @@ public function getIgnoredAttributes(): array
      */
     public function shouldLogTimestamps(): bool
     {
-        return $this->logTimestamps ?? Config::get('journal.timestamps', false);
+        return $this->logTimestamps ?? config()->get('journal.timestamps', false);
     }
 
     /**
@@ -214,7 +213,7 @@ public function shouldLogEvent(string $event): bool
      */
     public function getOriginalRelation(string $key, $default = null)
     {
-        return Arr::get($this->originalRelations, $key, $default);
+        return array_get($this->originalRelations, $key, $default);
     }
 
     /**

src/Events/ActivityPrepared.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Scrn\Journal\Events;
+
+use Scrn\Journal\Models\Activity;
+
+class ActivityPrepared
+{
+    protected $activity;
+
+    public function __construct(Activity $activity)
+    {
+        $this->activity = $activity;
+    }
+
+    public function getActivity(): Activity
+    {
+        return $this->activity;
+    }
+}

src/JournalServiceProvider.php

@@ -4,6 +4,8 @@
 
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
+use Scrn\Journal\Events\ActivityPrepared;
+use Scrn\Journal\Listeners\SaveActivity;
 
 class JournalServiceProvider extends ServiceProvider
 {
@@ -15,18 +17,20 @@ class JournalServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->publishes([
-            __DIR__ . '/../config/journal.php' => config_path('journal.php'),
+            __DIR__.'/../config/journal.php' => config_path('journal.php'),
         ], 'config');
 
         $this->publishes([
-            __DIR__ . '/../migrations/' => database_path('migrations'),
+            __DIR__.'/../migrations/' => database_path('migrations'),
         ], 'migrations');
 
         Event::subscribe(JournalEventSubscriber::class);
+
+        Event::listen(ActivityPrepared::class, SaveActivity::class);
     }
 
     public function register()
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/journal.php', 'journal');
+        $this->mergeConfigFrom(__DIR__.'/../config/journal.php', 'journal');
     }
 }

src/Listeners/SaveActivity.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Scrn\Journal\Listeners;
+
+use Scrn\Journal\Events\ActivityPrepared;
+
+class SaveActivity
+{
+    public function handle(ActivityPrepared $event)
+    {
+        $event->getActivity()->save();
+    }
+}