Learn about laravel model deletion and soft deletion in one article

##1. Delete the model

1.1 Use delete to delete a model

Deleting a model is very simple. First get the model instance to be deleted, and then call the delete method:

$post = Post::find(5);
if($post->delete()){
    echo '删除文章成功！';
}else{
    echo '删除文章失败！';
}

The The method returns true or false.

1.2 Use destroy to delete the model

Of course, if the model ID to be deleted is known, you can use the simpler method destroy to delete it directly:

$deleted = Post::destroy(5);

You can also delete multiple models by passing in multiple model IDs at one time:

$deleted = Post::destroy([1,2,3,4,5]);

Call the destroy method to return the number of deleted records.

1.3 Use the query builder to delete the model

Since it was mentioned earlier that the Eloquent model itself is a query builder, you can also delete the model using the query builder style, For example, if we want to delete all articles with 0 views, we can use the following method:

$deleted = Models\Post::where('views', 0)->delete();

The return result is the number of deleted articles.

2. Soft deletion implementation

The above deletion methods will delete the data table records from the database. In addition, the Eloquent model also supports soft deletion.

The so-called soft deletion means that the data table records are not actually deleted from the database, but the identification status of the table records is marked as soft deletion, so that it can be filtered when querying, so that the corresponding table records It looks like it has been "deleted". Laravel uses a date field as the identification status. This date field can be customized. Here we use deleted_at. If the corresponding model is soft-deleted, the value of the deleted_at field is the deletion time, otherwise the value is empty.

To make the Eloquent model support soft deletion, some settings need to be made. First, use SoftDeletestrait in the model class. This trait provides a series of related methods for soft deletion. For details, please refer to the source code Illuminate\Database\Eloquent\SoftDeletes. In addition, you must set the $date attribute array and place deleted_at in it:

<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
class Post extends Model
{
    use SoftDeletes;
    //设置表名
    public $table = &#39;posts&#39;;
    //设置主键
    public $primaryKey = &#39;id&#39;;
    //设置日期时间格式
    public $dateFormat = &#39;U&#39;;
    protected $guarded = [&#39;id&#39;,&#39;views&#39;,&#39;user_id&#39;,&#39;updated_at&#39;,&#39;created_at&#39;];
    protected $dates = [&#39;delete_at&#39;];
}

Then add the deleted_at column to the corresponding database posts. We use migration to implement it. First execute the Artisan command:

php artisan make:migration alter_posts_deleted_at --table=posts

Then edit the generated PHP file as follows:

<?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(&#39;posts&#39;, function (Blueprint $table) {
            $table->softDeletes();
        });
    }
    ...//其它方法
}

Then run:

php artisan migrate

So there is a deleted_at column in the posts. Next, we write the test code in the controller:

$post = Post::find(6);
$post->delete();
if($post->trashed()){
    echo '软删除成功！';
    dd($post);
}else{
    echo '软删除失败！';
}

What if we want to include soft-deleted records in the query results? You can use the withTrashed method on the SoftDeletes trait:

$posts = Post::withTrashed()->get();
dd($posts);

Sometimes we only want to view the soft-deleted model. There is also a trick, through the onlyTrashed method on SoftDeletes:

$posts = Post::onlyTrashed()->get();
dd($posts);

Soft Deletion Recovery

Sometimes we need to restore a soft-deleted model. You can use the restore method provided by SoftDeletes:

Restore a single There is something wrong with model

$post = Post::find(6);
$post->restore();

. The one with ID 6 has been soft deleted. Post::find(6) cannot find the data.

should

$post = Post::withTrashed()->find(6);
$post->restore();

Restore multiple models

Post::withTrashed()->where('id','>',1)->restore();

Restore all models

Post::withTrashed()->restore();

Restore associated query model

$post = Post::find(6);
$post->history()->restore();

Forced deletion

If the model is configured with soft deletion but we really want to delete the database table records corresponding to the model, we can use the forceDelete method provided by SoftDeletes:

$post = Post::find(6);
$post->forceDelete();

PHP Chinese website, a large number of free

laravel introductory tutorials, welcome to learn online!

This article is reproduced from: https://blog.csdn.net/weixin_38112233/article/details/78574007

The above is the detailed content of Learn about laravel model deletion and soft deletion in one article. For more information, please follow other related articles on the PHP Chinese website!