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.
134 lines
4.1 KiB
134 lines
4.1 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\behaviors; |
|
|
|
use Closure; |
|
use yii\base\Event; |
|
use yii\base\InvalidCallException; |
|
use yii\db\BaseActiveRecord; |
|
use yii\db\Expression; |
|
|
|
/** |
|
* TimestampBehavior automatically fills the specified attributes with the current timestamp. |
|
* |
|
* To use TimestampBehavior, insert the following code to your ActiveRecord class: |
|
* |
|
* ```php |
|
* use yii\behaviors\TimestampBehavior; |
|
* |
|
* public function behaviors() |
|
* { |
|
* return [ |
|
* TimestampBehavior::className(), |
|
* ]; |
|
* } |
|
* ``` |
|
* |
|
* By default, TimestampBehavior will fill the `created_at` and `updated_at` attributes with the current timestamp |
|
* when the associated AR object is being inserted; it will fill the `updated_at` attribute |
|
* with the timestamp when the AR object is being updated. The timestamp value is obtained by `time()`. |
|
* |
|
* If your attribute names are different or you want to use a different way of calculating the timestamp, |
|
* you may configure the [[createdAtAttribute]], [[updatedAtAttribute]] and [[value]] properties like the following: |
|
* |
|
* ```php |
|
* use yii\db\Expression; |
|
* |
|
* public function behaviors() |
|
* { |
|
* return [ |
|
* [ |
|
* 'class' => TimestampBehavior::className(), |
|
* 'createdAtAttribute' => 'create_time', |
|
* 'updatedAtAttribute' => 'update_time', |
|
* 'value' => new Expression('NOW()'), |
|
* ], |
|
* ]; |
|
* } |
|
* ``` |
|
* |
|
* In case you use an [[Expression]] object as in the example above, the attribute will not hold the timestamp value, but |
|
* the Expression object itself after the record has been saved. If you need the value from DB afterwards you should call |
|
* the [[\yii\db\ActiveRecord::refresh()|refresh()]] method of the record. |
|
* |
|
* TimestampBehavior also provides a method named [[touch()]] that allows you to assign the current |
|
* timestamp to the specified attribute(s) and save them to the database. For example, |
|
* |
|
* ```php |
|
* $model->touch('creation_time'); |
|
* ``` |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @author Alexander Kochetov <creocoder@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class TimestampBehavior extends AttributeBehavior |
|
{ |
|
/** |
|
* @var string the attribute that will receive timestamp value |
|
* Set this property to false if you do not want to record the creation time. |
|
*/ |
|
public $createdAtAttribute = 'created_at'; |
|
/** |
|
* @var string the attribute that will receive timestamp value. |
|
* Set this property to false if you do not want to record the update time. |
|
*/ |
|
public $updatedAtAttribute = 'updated_at'; |
|
/** |
|
* {@inheritdoc} |
|
* In case, when the value is null - the [[time()]] function value will be used. |
|
*/ |
|
public $value; |
|
|
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
public function init() |
|
{ |
|
parent::init(); |
|
|
|
if (empty($this->attributes)) { |
|
$this->attributes = [ |
|
BaseActiveRecord::EVENT_BEFORE_INSERT => [$this->createdAtAttribute, $this->updatedAtAttribute], |
|
BaseActiveRecord::EVENT_BEFORE_UPDATE => $this->updatedAtAttribute, |
|
]; |
|
} |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* [[time()]] function return value will be used, when [[value]] is null. |
|
*/ |
|
protected function getValue($event) |
|
{ |
|
if ($this->value === null) { |
|
return time(); |
|
} |
|
return parent::getValue($event); |
|
} |
|
|
|
/** |
|
* Updates a timestamp attribute to the current timestamp. |
|
* |
|
* ```php |
|
* $model->touch('lastVisit'); |
|
* ``` |
|
* @param string $attribute the name of the attribute to update. |
|
* @throws InvalidCallException if owner is a new record (since version 2.0.6). |
|
*/ |
|
public function touch($attribute) |
|
{ |
|
/* @var $owner BaseActiveRecord */ |
|
$owner = $this->owner; |
|
if ($owner->getIsNewRecord()) { |
|
throw new InvalidCallException('Updating the timestamp is not possible on a new record.'); |
|
} |
|
$owner->updateAttributes(array_fill_keys((array) $attribute, $this->getValue(null))); |
|
} |
|
}
|
|
|