对于任何一个模型,如果需要使用软删除功能,需要在模型中使用 Illuminate\Database\Eloquent\SoftDeletes
这个 trait 。软删除功能需要实现的功能有以下几点:
1.模型执行删除操作,只标记删除,不执行真正的数据删除
2.查询的时候自动过滤已经标记为删除的数据
3.可以设置是否查询已删除的数据,可以设置只查询已删除的数据
4.已删除数据可以恢复
Model的软删除功能实现
Illuminate\Database\Eloquent\Model 中delete方法源码: public function delete() { if (is_null($this->getKeyName())) { throw new Exception('No primary key defined on model.'); } if (! $this->exists) { return; } if ($this->fireModelEvent('deleting') === false) { return false; } $this->touchOwners(); $this->performDeleteOnModel(); $this->fireModelEvent('deleted', false); return true; } protected function performDeleteOnModel() { $this->setKeysForSaveQuery($this->newModelQuery()) ->delete(); $this->exists = false; }
因为在子类中使用了 SoftDeletes trait,所以, SoftDeletes
的 performDeleteOnModel
方法会覆盖父类的方法,最终通过 runSoftDelete
方法更新删除标记。
protected function performDeleteOnModel() { if ($this->forceDeleting) { $this->exists = false; return $this->newModelQuery()->where( $this->getKeyName(), $this->getKey() )->forceDelete(); } return $this->runSoftDelete(); } protected function runSoftDelete() { $query = $this->newModelQuery() ->where($this->getKeyName(), $this->getKey()); $time = $this->freshTimestamp(); $columns = [$this->getDeletedAtColumn() => $this->fromDateTime($time)]; $this->{$this->getDeletedAtColumn()} = $time; if ($this->timestamps && ! is_null($this->getUpdatedAtColumn())) { $this->{$this->getUpdatedAtColumn()} = $time; $columns[$this->getUpdatedAtColumn()] = $this->fromDateTime($time); } $query->update($columns); }
Model查询过滤删除数据
Laravel中允许在Model中 static::addGlobalScope
方法添加全局的 Scope 。这样就可以在查询条件中添加一个全局条件。Laravel中软删除数据的过滤也是使用这种方式实现的。
SoftDeletes trait中加入了 Illuminate\Database\Eloquent\SoftDeletingScope
全局的 Scope 。并在 SoftDeletingScope 中实现查询自动过滤被删除数据,指定查询已删除数据功能。
public static function bootSoftDeletes() { static::addGlobalScope(new SoftDeletingScope); }
内容版权声明:除非注明,否则皆为本站原创文章。