You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
111 lines
3.3 KiB
111 lines
3.3 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\behaviors; |
|
|
|
use Yii; |
|
use yii\base\Event; |
|
use yii\db\BaseActiveRecord; |
|
|
|
/** |
|
* BlameableBehavior automatically fills the specified attributes with the current user ID. |
|
* |
|
* To use BlameableBehavior, insert the following code to your ActiveRecord class: |
|
* |
|
* ```php |
|
* use yii\behaviors\BlameableBehavior; |
|
* |
|
* public function behaviors() |
|
* { |
|
* return [ |
|
* BlameableBehavior::className(), |
|
* ]; |
|
* } |
|
* ``` |
|
* |
|
* By default, BlameableBehavior will fill the `created_by` and `updated_by` attributes with the current user ID |
|
* when the associated AR object is being inserted; it will fill the `updated_by` attribute |
|
* with the current user ID when the AR object is being updated. If your attribute names are different, you may configure |
|
* the [[createdByAttribute]] and [[updatedByAttribute]] properties like the following: |
|
* |
|
* ```php |
|
* public function behaviors() |
|
* { |
|
* return [ |
|
* [ |
|
* 'class' => BlameableBehavior::className(), |
|
* 'createdByAttribute' => 'author_id', |
|
* 'updatedByAttribute' => 'updater_id', |
|
* ], |
|
* ]; |
|
* } |
|
* ``` |
|
* |
|
* @author Luciano Baraglia <luciano.baraglia@gmail.com> |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @author Alexander Kochetov <creocoder@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class BlameableBehavior extends AttributeBehavior |
|
{ |
|
/** |
|
* @var string the attribute that will receive current user ID value |
|
* Set this property to false if you do not want to record the creator ID. |
|
*/ |
|
public $createdByAttribute = 'created_by'; |
|
/** |
|
* @var string the attribute that will receive current user ID value |
|
* Set this property to false if you do not want to record the updater ID. |
|
*/ |
|
public $updatedByAttribute = 'updated_by'; |
|
/** |
|
* @var callable the value that will be assigned to the attributes. This should be a valid |
|
* PHP callable whose return value will be assigned to the current attribute(s). |
|
* The signature of the callable should be: |
|
* |
|
* ```php |
|
* function ($event) { |
|
* // return value will be assigned to the attribute(s) |
|
* } |
|
* ``` |
|
* |
|
* If this property is not set, the value of `Yii::$app->user->id` will be assigned to the attribute(s). |
|
*/ |
|
public $value; |
|
|
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
public function init() |
|
{ |
|
parent::init(); |
|
|
|
if (empty($this->attributes)) { |
|
$this->attributes = [ |
|
BaseActiveRecord::EVENT_BEFORE_INSERT => [$this->createdByAttribute, $this->updatedByAttribute], |
|
BaseActiveRecord::EVENT_BEFORE_UPDATE => $this->updatedByAttribute, |
|
]; |
|
} |
|
} |
|
|
|
/** |
|
* Evaluates the value of the user. |
|
* The return result of this method will be assigned to the current attribute(s). |
|
* @param Event $event |
|
* @return mixed the value of the user. |
|
*/ |
|
protected function getValue($event) |
|
{ |
|
if ($this->value === null) { |
|
$user = Yii::$app->get('user', false); |
|
return $user && !$user->isGuest ? $user->id : null; |
|
} else { |
|
return call_user_func($this->value, $event); |
|
} |
|
} |
|
}
|
|
|