TimestampBehavior.php 3.67 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\behaviors;

use yii\db\BaseActiveRecord;
use yii\db\Expression;

/**
 * TimestampBehavior automatically fills the specified attributes with the current timestamp.
 *
16
 * To use TimestampBehavior, insert the following code to your ActiveRecord class:
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 *
 * ```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,
34
 * you may configure the [[createdAtAttribute]], [[updatedAtAttribute]] and [[value]] properties like the following:
35 36 37 38 39 40 41
 *
 * ```php
 * use yii\db\Expression;
 *
 * public function behaviors()
 * {
 *     return [
42
 *         [
43
 *             'class' => TimestampBehavior::className(),
44 45
 *             'createdAtAttribute' => 'create_time',
 *             'updatedAtAttribute' => 'update_time',
46 47 48 49 50 51 52 53 54 55
 *             'value' => new Expression('NOW()'),
 *         ],
 *     ];
 * }
 * ```
 *
 * 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
56
 * $model->touch('creation_time');
57 58 59
 * ```
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
60
 * @author Alexander Kochetov <creocoder@gmail.com>
61 62 63 64
 * @since 2.0
 */
class TimestampBehavior extends AttributeBehavior
{
65
    /**
66
     * @var string the attribute that will receive timestamp value
Alexander Makarov committed
67
     * Set this property to false if you do not want to record the creation time.
68
     */
69 70
    public $createdAtAttribute = 'created_at';
    /**
71
     * @var string the attribute that will receive timestamp value.
Alexander Makarov committed
72
     * Set this property to false if you do not want to record the update time.
73 74
     */
    public $updatedAtAttribute = 'updated_at';
75 76 77 78 79 80 81
    /**
     * @var callable|Expression The expression that will be used for generating the timestamp.
     * This can be either an anonymous function that returns the timestamp value,
     * or an [[Expression]] object representing a DB expression (e.g. `new Expression('NOW()')`).
     * If not set, it will use the value of `time()` to set the attributes.
     */
    public $value;
82

83

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
    /**
     * @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,
            ];
        }
    }

99 100 101 102 103 104 105 106 107 108 109
    /**
     * @inheritdoc
     */
    protected function getValue($event)
    {
        if ($this->value instanceof Expression) {
            return $this->value;
        } else {
            return $this->value !== null ? call_user_func($this->value, $event) : time();
        }
    }
110

111 112 113 114 115 116 117 118 119 120 121 122
    /**
     * Updates a timestamp attribute to the current timestamp.
     *
     * ```php
     * $model->touch('lastVisit');
     * ```
     * @param string $attribute the name of the attribute to update.
     */
    public function touch($attribute)
    {
        $this->owner->updateAttributes(array_fill_keys((array) $attribute, $this->getValue(null)));
    }
123
}