Merge pull request #175 from denydias/related-model

Fix #163: optionally include the model related to the activity.

Author: jeremykenedy

README.md

@@ -39,7 +39,8 @@ Laravel logger is an activity event logger for your Laravel or Lumen application
 |Records activity timestamps|
 |Records activity description|
 |Records activity details (optional)|
-|Records activity user type with crawler detection.|
+|Records model related to the activity (optional)|
+|Records activity user type with crawler detection|
 |Records activity Method|
 |Records activity Route|
 |Records activity Ip Address|
@@ -234,7 +235,7 @@ To use the trait:
         use ActivityLogger;
     ```
 
-3. You can record the activity my calling the traits method:
+3. You can record the activity by calling the traits method:
     ```
         ActivityLogger::activity("Logging this activity.");
     ```
@@ -244,6 +245,11 @@ To use the trait:
         ActivityLogger::activity("Logging this activity.", "Additional activity details.");
     ```
 
+   Or even including the model related to the activity:
+    ```
+        ActivityLogger::activity("Logging this activity.", "Additional activity details.", ["id" => 1, "model" => "App\Models\User"]);
+    ```
+
 ### Routes
 ##### Laravel Activity Dashbaord Routes
 

src/App/Http/Traits/ActivityLogger.php

@@ -15,10 +15,11 @@ trait ActivityLogger
      *
      * @param null $description
      * @param null $details
+     * @param ?array $rel
      *
      * @return void
      */
-    public function activity($description = null, $details = null)
+    public function activity($description = null, $details = null, array $rel = null)
     {
         $userType = trans('LaravelLogger::laravel-logger.userTypes.guest');
         $userId = null;
@@ -68,6 +69,13 @@ public function activity($description = null, $details = null)
             $ip = Request::ip();
         }
 
+        $relId = null;
+        $relModel = null;
+        if (is_array($rel) && array_key_exists('id', $rel) && array_key_exists('model', $rel)) {
+            $relId = $rel['id'];
+            $relModel = $rel['model'];
+        }
+
         $data = [
             'description'   => $description,
             'details'       => $details,
@@ -79,6 +87,8 @@ public function activity($description = null, $details = null)
             'locale'        => Request::header('accept-language'),
             'referer'       => Request::header('referer'),
             'methodType'    => Request::method(),
+            'relId'         => $relId,
+            'relModel'      => $relModel,
         ];
 
         // Validation Instance
@@ -113,6 +123,8 @@ private static function storeActivity($data)
             'locale'        => $data['locale'],
             'referer'       => $data['referer'],
             'methodType'    => $data['methodType'],
+            'relId'         => $data['relId'],
+            'relModel'      => $data['relModel'],
         ]);
     }
 

src/database/migrations/2017_11_04_103444_create_laravel_logger_activity_table.php

@@ -32,6 +32,8 @@ public function up()
                 $table->string('locale')->nullable();
                 $table->longText('referer')->nullable();
                 $table->string('methodType')->nullable();
+                $table->unsignedBigInteger('relId')->index()->nullable();
+                $table->string('relModel')->nullable();
                 $table->timestamps();
                 $table->softDeletes();
             });