CTimestampBehavior

public function behaviors(){
	return array(
		'CTimestampBehavior' => array(
			'class' => 'zii.behaviors.CTimestampBehavior',
			'createAttribute' => 'create_time_attribute',
			'updateAttribute' => 'update_time_attribute',
		)
	);
}

Property Details

createAttribute property

public mixed $createAttribute;

The name of the attribute to store the creation time. Set to null to not use a timestamp for the creation attribute. Defaults to 'create_time'

map property

protected static array $map;

Maps column types to database method

setUpdateOnCreate property

public bool $setUpdateOnCreate;

Whether to set the update attribute to the creation timestamp upon creation. Otherwise it will be left alone. Defaults to false.

timestampExpression property

public mixed $timestampExpression;

The expression that will be used for generating the timestamp. This can be either a string representing a PHP expression (e.g. 'time()'), or a CDbExpression object representing a DB expression (e.g. new CDbExpression('NOW()')). Defaults to null, meaning that we will attempt to figure out the appropriate timestamp automatically. If we fail at finding the appropriate timestamp, then it will fall back to using the current UNIX timestamp.

A PHP expression can be any PHP code that has a value. To learn more about what an expression is, please refer to the php manual.

updateAttribute property

public mixed $updateAttribute;

The name of the attribute to store the modification time. Set to null to not use a timestamp for the update attribute. Defaults to 'update_time'

Method Details

beforeSave() method

public void beforeSave(CModelEvent $event)

public function beforeSave($event) {
    if ($this->getOwner()->getIsNewRecord() && ($this->createAttribute !== null)) {
        $this->getOwner()->{$this->createAttribute} = $this->getTimestampByAttribute($this->createAttribute);
    }
    if ((!$this->getOwner()->getIsNewRecord() || $this->setUpdateOnCreate) && ($this->updateAttribute !== null)) {
        $this->getOwner()->{$this->updateAttribute} = $this->getTimestampByAttribute($this->updateAttribute);
    }
}

Responds to CModel::onBeforeSave event. Sets the values of the creation or modified attributes as configured

getTimestampByAttribute() method

protected mixed getTimestampByAttribute(string $attribute)

protected function getTimestampByAttribute($attribute) {
    if ($this->timestampExpression instanceof CDbExpression)
        return $this->timestampExpression;
    elseif ($this->timestampExpression !== null)
    {
        try
        {
            return @eval('return '.$this->timestampExpression.';');
        }
        catch (ParseError $e)
        {
            return false;
        }
    }

    $columnType = $this->getOwner()->getTableSchema()->getColumn($attribute)->dbType;
    return $this->getTimestampByColumnType($columnType);
}

Gets the appropriate timestamp depending on the column type $attribute is

getTimestampByColumnType() method

protected mixed getTimestampByColumnType(string $columnType)

protected function getTimestampByColumnType($columnType) {
    return isset(self::$map[$columnType]) ? new CDbExpression(self::$map[$columnType]) : time();
}

Returns the appropriate timestamp depending on $columnType