8個Laravel模型時間戳使用技巧,你都沒用過

默認情況下,Laravel Eloquent 模型默認數據表有 created_at 和 updated_at 兩個字段。當然,我們可以做很多自定義配置,實現很多有趣的功能。下面舉例說明。

1. 禁用時間戳
如果數據表沒有這兩個字段,保存數據時 Model::create($arrayOfValues); —— 會看到 SQL error。Laravel 在自動填充 created_at / updated_at 的時候,無法找到這兩個字段。
禁用自動填充時間戳,只需要在 Eloquent Model 添加上一個屬性:

class Role extends Model
{
  public $timestamps = FALSE;

  // ... 其他的屬性和方法
}

2. 修改時間戳默認列表
假如當前使用的是非 Laravel 類型的數據庫,也就是你的時間戳列的命名方式與此不同該怎麼辦?也許,它們分別叫做 create_time 和 update_time。恭喜,你也可以在模型種這麼定義:

class Role extends Model
{
  const CREATED_AT = 'create_time';
  const UPDATED_AT = 'update_time'; 

3. 修改時間戳日期 / 時間格式
以下內容引用官網文檔 official Laravel documentation:
默認情況下,時間戳自動格式爲 'Y-m-d H:i:s'。如果您需要自定義時間戳格式,可以在你的模型中設置 $dateFormat 屬性。這個屬性確定日期在數據庫中的存儲格式,以及在序列化成數組或 JSON 時的格式:

class Flight extends Model
{
  /**
   * 日期時間的存儲格式
   *
   * @var string
   */
  protected $dateFormat = 'U';
}

4. 多對多:帶時間戳的中間表
當在多對多的關聯中,時間戳不會自動填充,例如 用戶表 users 和 角色表 roles 的中間表 role_user。
在這個模型中您可以這樣定義關係:

class User extends Model
{
  public function roles()
  {
    return $this->belongsToMany(Role::class);
  }
}

然後當你想用戶中添加角色時,可以這樣使用:

$roleID = 1;
$user->roles()->attach($roleID);

默認情況下,這個中間表不包含時間戳。並且 Laravel 不會嘗試自動填充 created_at/updated_at
但是如果你想自動保存時間戳,您需要在遷移文件中添加 created_at/updated_at,然後在模型的關聯中加上 ->withTimestamps();

public function roles()
{
  return $this->belongsToMany(Role::class)->withTimestamps();
}

5. 使用 latest() 和 oldest() 進行時間戳排序
使用時間戳排序有兩個 “快捷方法”。
取而代之:

User::orderBy('created_at', 'desc')->get();

這麼做更快捷:
User::latest()->get();
默認情況,latest() 使用 created_at 排序。
與之對應,有一個 oldest() ,將會這麼排序 created_at ascending
User::oldest()->get();
當然,也可以使用指定的其他字段排序。例如,如果想要使用 updated_at,可以這麼做:

$lastUpdatedUser = User::latest('updated_at')->first();

6. 不觸發 updated_at 的修改
無論何時,當修改 Eloquent 記錄,都將會自動使用當前時間戳來維護 updated_at 字段,這是個非常棒的特性。
但是有時候你卻不想這麼做,例如:當增加某個值,認爲這不是 “整行更新”。
那麼,你可以一切如上 —— 只需禁用 timestamps,記住這是臨時的:

$user = User::find(1);
$user->profile_views_count = 123;
$user->timestamps = false;
$user->save();

7. 僅更新時間戳和關聯時間戳
與上一個例子恰好相反,也許您需要僅更新 updated_at 字段,而不改變其他列。
所以,不建議下面這種寫法:
$user->update(['updated_at' => now()]);

您可以使用更快捷的方法:
$user->touch();

另一種情況,有時候您不僅希望更新當前模型的 updated_at,也希望更新上級關係的記錄。
例如,某個 comment 被更新,那麼您希望將 post 表的 updated_at 也更新。
那麼,您需要在模型中定義 $touches 屬性:

class Comment extends Model {

  protected $touches = ['post'];

  public function post()
  {
    return $this->belongsTo('Post');
  }

}

8. 時間戳字段自動轉換 Carbon 類
最後一個技巧,但更像是一個提醒,因爲您應該已經知道它。
默認情況下,created_at 和 updated_at 字段被自動轉換爲 $dates,
所以您不需要將他們轉換爲 Carbon 實例,即可以使用 Carbon 的方法。
例如:

$user->created_at->addDays(3);
now()->diffInDays($user->updated_at);

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章