133 lines
3.8 KiB
PHP
133 lines
3.8 KiB
PHP
|
<?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\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.
|
||
|
|
*
|
||
|
|
* Because attribute values will be set automatically by this behavior, they are usually not user input and should therefore
|
||
|
|
* not be validated, i.e. `created_by` and `updated_by` should not appear in the [[\yii\base\Model::rules()|rules()]] method of the model.
|
||
|
|
*
|
||
|
|
* 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';
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* In case, when the property is `null`, the value of `Yii::$app->user->id` will be used as the value.
|
||
|
|
*/
|
||
|
|
public $value;
|
||
|
|
/**
|
||
|
|
* @var mixed Default value for cases when the user is guest
|
||
|
|
* @since 2.0.14
|
||
|
|
*/
|
||
|
|
public $defaultValue;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@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,
|
||
|
|
];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* 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')) {
|
||
|
|
$userId = Yii::$app->get('user')->id;
|
||
|
|
if ($userId === null) {
|
||
|
|
return $this->getDefaultValue($event);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $userId;
|
||
|
|
} elseif ($this->value === null) {
|
||
|
|
return $this->getDefaultValue($event);
|
||
|
|
}
|
||
|
|
|
||
|
|
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;
|
||
|
|
}
|
||
|
|
}
|