PHP框架怎样实现数据的软删除功能 PHP框架软删除的实用技巧教程

deleted_at

DELETE

newQuery

where deleted_at is null

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;

class BaseModel extends Model
{
    /**
     * 覆盖 newQuery 方法
     *
     * @param  bool  $excludeDeleted  是否排除软删除的数据
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function newQuery($excludeDeleted = true)
    {
        $query = parent::newQuery();

        if ($excludeDeleted && $this->isSoftDeletable()) {
            $query->whereNull('deleted_at');
        }

        return $query;
    }

    /**
     * 判断模型是否使用了软删除
     *
     * @return bool
     */
    protected function isSoftDeletable(): bool
    {
        return method_exists($this, 'bootSoftDeletes');
    }
}

isSoftDeletable

whereNull('deleted_at')

BaseModel

<?php

namespace App\Traits;

use Illuminate\Support\Carbon;

trait SoftDeletes
{
    /**
     * 执行软删除.
     *
     * @return bool|null
     *
     * @throws \Exception
     */
    public function delete()
    {
        if ($this->fireModelEvent('deleting') === false) {
            return false;
        }

        $this->{$this->getDeletedAtColumn()} = $this->freshTimestampString();

        $this->save();

        $this->fireModelEvent('deleted', false);

        return true;
    }

    /**
     * 获取 "deleted at" 字段的名称.
     *
     * @return string
     */
    public function getDeletedAtColumn()
    {
        return defined('static::DELETED_AT') ? static::DELETED_AT : 'deleted_at';
    }

    /**
     * 恢复被软删除的模型.
     *
     * @return bool|null
     *
     * @throws \Exception
     */
    public function restore()
    {
        // If the restoring event does not return false, we will proceed with this
        // restore operation. Once we have run the restoring event, we will set
        // the "deleted_at" attribute to null and save the model.
        if ($this->fireModelEvent('restoring') === false) {
            return false;
        }

        $this->{$this->getDeletedAtColumn()} = null;
        $this->exists = true;

        // Once we have saved the model, we will fire the restored event so that
        // any listeners can take the appropriate actions.
        $this->save();

        $this->fireModelEvent('restored', false);

        return true;
    }

    /**
     * 确定模型是否被软删除了.
     *
     * @return bool
     */
    public function trashed()
    {
        return ! is_null($this->{$this->getDeletedAtColumn()});
    }
}

<?php

namespace App\Models;

use App\Traits\SoftDeletes;

class User extends BaseModel
{
    use SoftDeletes;

    const DELETED_AT = 'is_deleted'; // 可以自定义 deleted_at 字段名

    protected $table = 'users';
}

deleted_at is null

deleted_at

restore

withTrashed()

$user = User::withTrashed()->find($id);

if ($user && $user->trashed()) {
    $user->restore();
}