Add logged model PK. Closes #1

migrations/m210917_105805_add_object_id_column_to_log_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Handles adding columns to table `{{%log}}`.
+ */
+class m210917_105805_add_object_id_column_to_log_table extends Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function safeUp()
+    {
+        $this->addColumn('goltratec_log', 'object_id', $this->integer());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function safeDown()
+    {
+        $this->dropColumn('goltratec_log', 'object_id');
+    }
+}

src/Log.php

@@ -15,6 +15,7 @@
  * @property integer $user
  * @property string $event
  * @property string $object
+ * @property integer $object_id
  */
 class Log extends ActiveRecord
 {
@@ -33,7 +34,7 @@ public function rules()
     {
         return [
             [['old_attributes', 'new_attributes'], 'string'],
-            [['user'], 'integer'],
+            [['user', 'object_id'], 'integer'],
             [['date'], 'safe'],
             [['event', 'object'], 'string', 'max' => 30],
         ];
@@ -54,22 +55,24 @@ public function attributeLabels()
         ];
     }
 
-    static function l(array $oldAttributes, array $newAttributes, $event, $object, $uid = false) {
+    static function l(array $oldAttributes, array $newAttributes, $event, $object, $uid = false, $object_id = null) {
 		$model = new self;
         $sender = $event->sender;
 		if (isset($sender->logIgnoredAttributes) && is_array($sender->logIgnoredAttributes) && count($sender->logIgnoredAttributes) > 0) {
             foreach ($sender->logIgnoredAttributes as $attr) {
                 unset($oldAttributes[$attr]);
                 unset($newAttributes[$attr]);
             }
-
         }
+
 		$model->old_attributes = Json::encode($oldAttributes);
 		$model->new_attributes = Json::encode($newAttributes);
 		$model->event = $event->name;
 		$model->object = $object;
 		$model->user = $uid;
         $model->date = new \yii\db\Expression('NOW()');
+        $model->object_id = $object_id;
+
 		$model->save();
 	}
 }

src/LogBehavior.php

@@ -25,7 +25,23 @@ public function handleLog($event) {
             $model->attributes,
             $event,
             $model::className(),
-            Yii::$app->user->id ?? null
+            Yii::$app->user->id ?? null,
+            $this->getPK($model)
         );
     }
+
+    /**
+     * Returns the PK of a given model given that it's formed by only one field.
+     * Rows with multiple fields as PKs are not currently supported
+     * @param $model
+     * @return false|mixed
+     */
+    private function getPK($model) {
+        $pks = $model::getTableSchema()->primaryKey;
+
+        if (count($pks) === 1)
+            return $model->{$pks[0]};
+
+        return null;
+    }
 }