深入理解 Laravel Eloquent(三)——模型刪除及軟刪除相關實現
1、刪除模型
1.1 使用delete刪除模型
刪除模型很簡單,先獲取要刪除的模型例項,然後呼叫delete
方法即可:
$post = Post::find(5); if($post->delete()){ echo '刪除文章成功!'; }else{ echo '刪除文章失敗!'; }
該方法返回true
或false
。
1.2 使用destroy刪除模型
當然如果已知要刪除的模型id的話,可以用更簡單的方法destroy
直接刪除:
$deleted = Post::destroy(5);
你也可以一次傳入多個模型id刪除多個模型:
$deleted = Post::destroy([1,2,3,4,5]);
呼叫destroy
方法返回被刪除的記錄數。
1.3 使用查詢構建器刪除模型
既然前面提到Eloquent模型本身就是查詢構建器,也可以使用查詢構建器風格刪除模型,比如我們要刪除所有瀏覽數為0的文章,可以使用如下方式:
$deleted = Models\Post::where('views', 0)->delete();
返回結果為被刪除的文章數。
2、軟刪除及其相關實現
2.1 軟刪除實現
上述刪除方法都會將資料表記錄從資料庫刪除,此外Eloquent模型還支援軟刪除。
所謂軟刪除指的是資料表記錄並未真的從資料庫刪除,而是將表記錄的標識狀態標記為軟刪除,這樣在查詢的時候就可以加以過濾,讓對應表記錄看上去是被”刪除“了。Laravel中使用了一個日期欄位作為標識狀態,這個日期欄位可以自定義,這裡我們使用deleted_at
deleted_at
欄位的值為刪除時間,否則該值為空。
要讓Eloquent模型支援軟刪除,還要做一些設定。首先在模型類中要使用SoftDeletes
trait,該trait為軟刪除提供一系列相關方法,具體可參考原始碼Illuminate\Database\Eloquent\SoftDeletes
,此外還要設定$date
屬性陣列,將deleted_at
置於其中:
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\SoftDeletes; class Post extends Model { use SoftDeletes; //設定表名 public $table = 'posts'; //設定主鍵 public $primaryKey = 'id'; //設定日期時間格式 public $dateFormat = 'U'; protected $guarded = ['id','views','user_id','updated_at','created_at']; protected $dates = ['delete_at']; }
然後對應的資料庫posts
中新增deleted_at
列,我們使用遷移來實現,先執行Artisan命令:
php artisan make:migration alter_posts_deleted_at --table=posts
然後編輯生成的PHP檔案如下:
<?php use Illuminate\Database\Schema\Blueprint; use Illuminate\Database\Migrations\Migration; class AlterPostsDeletedAt extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::table('posts', function (Blueprint $table) { $table->softDeletes(); }); } ...//其它方法 }
然後執行:
php artisan migrate
這樣posts
中就有了deleted_at
列。接下來,我們在控制器中編寫測試程式碼:
$post = Post::find(6); $post->delete(); if($post->trashed()){ echo '軟刪除成功!'; dd($post); }else{ echo '軟刪除失敗!'; }
在瀏覽器中訪問http://laravel.app:8000/test
,頁面輸出如下:
當我們再次通過下面這段程式碼獲取所有文章:
$posts = Post::all(); dd($posts);
已經看不到id為6的文章的身影了。
2.2 查詢結果包含軟刪除模型
那如果想要在查詢結果中包含軟刪除的記錄呢?可以使用SoftDeletes
trait上的withTrashed
方法:
$posts = Post::withTrashed()->get(); dd($posts);
執行之後頁面顯示如下:
id為6的文章又出現在了查詢結果中。有時候我們只想要檢視被軟刪除的模型,這也有招,通過SoftDeletes
上的onlyTrashed
方法即可:
$posts = Post::onlyTrashed()->get(); dd($posts);
執行後頁面顯示結果如下:
2.3 軟刪除恢復
有時候我們需要恢復被軟刪除的模型,可以使用SoftDeletes
提供的restore
方法:
恢復單個模型
$post = Post::find(6); $post->restore();
恢復多個模型
Post::withTrashed()->where('id','>',1)->restore();
恢復所有模型
Post::withTrashed()->restore();
恢復關聯查詢模型
$post = Post::find(6); $post->history()->restore();
2.4 強制刪除
如果模型配置了軟刪除但我們確實要刪除改模型對應資料庫表記錄,則可以使用SoftDeletes
提供的forceDelete
方法:
$post = Post::find(6); $post->forceDelete();
檢視資料表可以發現id=6的表記錄已經被刪除,不復存在:
該方法也支援關聯模型強制刪除,我們後面講到關聯關係的時候再具體說明。