<?php
|
|
// +----------------------------------------------------------------------
|
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
|
// +----------------------------------------------------------------------
|
// | Copyright (c) 2006~2023 http://thinkphp.cn All rights reserved.
|
// +----------------------------------------------------------------------
|
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
|
// +----------------------------------------------------------------------
|
// | Author: liu21st <liu21st@gmail.com>
|
// +----------------------------------------------------------------------
|
declare(strict_types=1);
|
|
namespace think\model\concern;
|
|
use DateTime;
|
use DateTimeInterface;
|
use Stringable;
|
|
/**
|
* 自动时间戳.
|
*/
|
trait TimeStamp
|
{
|
/**
|
* 是否需要自动写入时间戳 如果设置为字符串 则表示时间字段的类型.
|
*
|
* @var bool|string
|
*/
|
protected $autoWriteTimestamp;
|
|
/**
|
* 创建时间字段 false表示关闭.
|
*
|
* @var false|string
|
*/
|
protected $createTime = 'create_time';
|
|
/**
|
* 更新时间字段 false表示关闭.
|
*
|
* @var false|string
|
*/
|
protected $updateTime = 'update_time';
|
|
/**
|
* 时间字段显示格式.
|
*
|
* @var string
|
*/
|
protected $dateFormat;
|
|
/**
|
* 是否需要自动写入时间字段.
|
*
|
* @param bool|string $auto
|
*
|
* @return $this
|
*/
|
public function isAutoWriteTimestamp($auto)
|
{
|
$this->autoWriteTimestamp = $this->checkTimeFieldType($auto);
|
|
return $this;
|
}
|
|
/**
|
* 检测时间字段的实际类型.
|
*
|
* @param bool|string $type
|
*
|
* @return mixed
|
*/
|
protected function checkTimeFieldType($type)
|
{
|
if (true === $type) {
|
if (isset($this->type[$this->createTime])) {
|
$type = $this->type[$this->createTime];
|
} elseif (isset($this->schema[$this->createTime]) && in_array($this->schema[$this->createTime], ['datetime', 'date', 'timestamp', 'int'])) {
|
$type = $this->schema[$this->createTime];
|
} else {
|
$type = $this->getFieldType($this->createTime);
|
}
|
}
|
|
return $type;
|
}
|
|
/**
|
* 设置时间字段名称.
|
*
|
* @param string $createTime
|
* @param string $updateTime
|
*
|
* @return $this
|
*/
|
public function setTimeField(string $createTime, string $updateTime)
|
{
|
$this->createTime = $createTime;
|
$this->updateTime = $updateTime;
|
|
return $this;
|
}
|
|
/**
|
* 获取自动写入时间字段.
|
*
|
* @return bool|string
|
*/
|
public function getAutoWriteTimestamp()
|
{
|
return $this->autoWriteTimestamp;
|
}
|
|
/**
|
* 设置时间字段格式化.
|
*
|
* @param string|false $format
|
*
|
* @return $this
|
*/
|
public function setDateFormat($format)
|
{
|
$this->dateFormat = $format;
|
|
return $this;
|
}
|
|
/**
|
* 获取自动写入时间字段.
|
*
|
* @return string|false
|
*/
|
public function getDateFormat()
|
{
|
return $this->dateFormat;
|
}
|
|
/**
|
* 自动写入时间戳.
|
*
|
* @return mixed
|
*/
|
protected function autoWriteTimestamp()
|
{
|
// 检测时间字段类型
|
$type = $this->checkTimeFieldType($this->autoWriteTimestamp);
|
|
return is_string($type) ? $this->getTimeTypeValue($type) : time();
|
}
|
|
/**
|
* 获取指定类型的时间字段值
|
*
|
* @param string $type 时间字段类型
|
*
|
* @return mixed
|
*/
|
protected function getTimeTypeValue(string $type)
|
{
|
$value = time();
|
|
switch ($type) {
|
case 'datetime':
|
case 'date':
|
case 'timestamp':
|
$value = $this->formatDateTime('Y-m-d H:i:s.u');
|
break;
|
default:
|
if (str_contains($type, '\\')) {
|
// 对象数据写入
|
$obj = new $type();
|
if ($obj instanceof Stringable) {
|
// 对象数据写入
|
$value = $obj->__toString();
|
}
|
}
|
}
|
|
return $value;
|
}
|
|
/**
|
* 时间日期字段格式化处理.
|
*
|
* @param mixed $format 日期格式
|
* @param mixed $time 时间日期表达式
|
* @param bool $timestamp 时间表达式是否为时间戳
|
*
|
* @return mixed
|
*/
|
protected function formatDateTime($format, $time = 'now', bool $timestamp = false)
|
{
|
if (empty($time)) {
|
return $time;
|
}
|
|
if (false === $format) {
|
return $time;
|
} elseif (str_contains($format, '\\')) {
|
return new $format($time);
|
}
|
|
if ($time instanceof DateTimeInterface) {
|
$dateTime = $time;
|
} elseif ($timestamp) {
|
$dateTime = new DateTime();
|
$dateTime->setTimestamp(is_numeric($time) ? (int) $time : strtotime($time));
|
} else {
|
$dateTime = new DateTime($time);
|
}
|
|
return $dateTime->format($format);
|
}
|
|
/**
|
* 获取时间字段值
|
*
|
* @param mixed $value
|
*
|
* @return mixed
|
*/
|
protected function getTimestampValue($value)
|
{
|
$type = $this->checkTimeFieldType($this->autoWriteTimestamp);
|
|
if (is_string($type) && in_array(strtolower($type), [
|
'datetime', 'date', 'timestamp',
|
])) {
|
$value = $this->formatDateTime($this->dateFormat, $value);
|
} else {
|
$value = $this->formatDateTime($this->dateFormat, $value, true);
|
}
|
|
return $value;
|
}
|
}
|
