Fixes #5515: Added default value for `yii\behaviors\BlameableBehavior` for cases when the user is guest

framework/CHANGELOG.md

@@ -4,6 +4,7 @@ Yii Framework 2 Change Log
 2.0.14 under development
 ------------------------
 
+- Enh #5515: Added default value for `yii\behaviors\BlameableBehavior` for cases when the user is guest (dmirogin)
 - Bug #14276: Fixed I18N format with dotted parameters (developeruz)
 - Bug #14604: Fixed `yii\validators\CompareValidator` `compareAttribute` does not work if `compareAttribute` form ID has been changed (mikk150) 
 - Bug #15194: Fixed `yii\db\QueryBuilder::insert()` to preserve passed params when building a `INSERT INTO ... SELECT` query for MSSQL, PostgreSQL and SQLite (sergeymakinen)

framework/behaviors/AttributeBehavior.php

@@ -140,7 +140,7 @@ class AttributeBehavior extends Behavior
      */
     protected function getValue($event)
     {
-        if ($this->value instanceof Closure || is_array($this->value) && is_callable($this->value)) {
+        if ($this->value instanceof Closure || (is_array($this->value) && is_callable($this->value))) {
             return call_user_func($this->value, $event);
         }
 

framework/behaviors/BlameableBehavior.php

@@ -73,6 +73,11 @@ class BlameableBehavior extends AttributeBehavior
      */
     public $value;
 
+    /**
+     * @var mixed Default value for cases when the user is guest
+     * @since 2.0.14
+     */
+    public $defaultValue;
 
     /**
      * @inheritdoc
@@ -92,14 +97,34 @@ class BlameableBehavior extends AttributeBehavior
     /**
      * @inheritdoc
      *
-     * In case, when the [[value]] property is `null`, the value of `Yii::$app->user->id` will be used as the value.
+     * In case, when the [[value]] property is `null`, the value of [[defaultValue]] will be used as the value.
      */
     protected function getValue($event)
     {
         if ($this->value === null && Yii::$app->has('user')) {
-            return Yii::$app->get('user')->id;
+            $userId = Yii::$app->get('user')->id;
+            if ($userId === null) {
+                return $this->getDefaultValue($event);
+            }
+
+            return $userId;
         }
 
         return parent::getValue($event);
     }
+
+    /**
+     * Get default value
+     * @param \yii\base\Event $event
+     * @return array|mixed
+     * @since 2.0.14
+     */
+    protected function getDefaultValue($event)
+    {
+        if ($this->defaultValue instanceof \Closure || (is_array($this->defaultValue) && is_callable($this->defaultValue))) {
+            return call_user_func($this->defaultValue, $event);
+        }
+
+        return $this->defaultValue;
+    }
 }

tests/framework/behaviors/BlameableBehaviorTest.php

@@ -154,6 +154,52 @@ class BlameableBehaviorTest extends TestCase
         $this->assertEquals(20, $model->created_by);
         $this->assertEquals(20, $model->updated_by);
     }
+
+    public function testDefaultValue()
+    {
+        $this->getUser()->logout();
+
+        $model = new ActiveRecordBlameable([
+            'as blameable' => [
+                'class' => BlameableBehavior::className(),
+                'defaultValue' => 2
+            ],
+        ]);
+
+        $model->name = __METHOD__;
+        $model->beforeSave(true);
+
+        $this->assertEquals(2, $model->created_by);
+        $this->assertEquals(2, $model->updated_by);
+    }
+
+    public function testDefaultValueWithClosure()
+    {
+        $model = new ActiveRecordBlameableWithDefaultValueClosure();
+        $model->name = __METHOD__;
+        $model->beforeSave(true);
+
+        $this->getUser()->logout();
+        $model->beforeSave(true);
+
+        $this->assertEquals(11, $model->created_by);
+        $this->assertEquals(11, $model->updated_by);
+    }
+}
+
+class ActiveRecordBlameableWithDefaultValueClosure extends ActiveRecordBlameable
+{
+    public function behaviors()
+    {
+        return [
+            'blameable' => [
+                'class' => BlameableBehavior::className(),
+                'defaultValue' => function () {
+                    return $this->created_by + 1;
+                }
+            ],
+        ];
+    }
 }
 
 /**