README

目的

此 CakePHP 插件使您能够使模型支持软删除。当软删除一个实体时，它实际上不会被从数据库中删除。相反，会在记录上设置一个 deleted 时间戳。

要求

此插件是为 cakephp 4.x 开发的。

安装

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。

更新您的 composer 文件以包含此插件

composer require imo-tikuwa/cakephp-soft-delete "2.*"

配置

加载插件

// In /config/bootstrap.php
Plugin::load('SoftDelete');

使模型支持软删除

在您的模型 Table 类中使用 SoftDelete 特性

// in src/Model/Table/UsersTable.php
...
use SoftDelete\Model\Table\SoftDeleteTrait;

class UsersTable extends Table
{
    use SoftDeleteTrait;
    ...

您的软删除模型数据库表应该有一个名为 deleted 的字段，类型为 DateTime，默认值为 NULL。如果您想自定义此字段，可以在 Table 类中声明该字段。

// in src/Model/Table/UsersTable.php
...
use SoftDelete\Model\Table\SoftDeleteTrait;

class UsersTable extends Table
{
    use SoftDeleteTrait;

    protected $softDeleteField = 'deleted_date';
    ...

使用

软删除记录

delete 和 deleteAll 函数现在将使用删除日期填充 deleted 字段来软删除记录。

// in src/Model/Table/UsersTable.php
$this->delete($user); // $user entity is now soft deleted if UsersTable uses SoftDeleteTrait.

恢复软删除记录

要恢复一个软删除的实体到活动状态，请使用 restore 方法

// in src/Model/Table/UsersTable.php
// Let's suppose $user #1 is soft deleted.
$user = $this->Users->find('all', ['withDeleted'])->where('id', 1)->first();
$this->restore($user); // $user #1 is now restored.

查找记录

find、get 或动态查找器（如 findById）将仅返回非软删除的记录。要同时返回软删除的记录，$options 必须包含 'withDeleted'。示例

// in src/Model/Table/UsersTable.php
$nonSoftDeletedRecords = $this->find('all');
$allRecords            = $this->find('all', ['withDeleted']);

硬删除记录

要硬删除单个实体

// in src/Model/Table/UsersTable.php
$user = $this->get($userId);
$success = $this->hardDelete($user);

要批量硬删除在给定日期之前软删除的记录，可以使用 hardDeleteAll($date)

// in src/Model/Table/UsersTable.php
$date = new \DateTime('some date');
$affectedRowsCount = $this->hardDeleteAll($date);

软删除 & 关联

关联由 SoftDelete 插件正确处理。

1. 软删除将按常规级联到相关模型。如果相关模型也使用 SoftDelete 特性，它们将被软删除。
2. 软删除的记录将被排除在计数器缓存之外。