alusev / cakephp-soft-delete
CakePHP 软删除插件
2.0.1
2020-01-11 08:57 UTC
Requires
- php: >=7.2
- cakephp/cakephp: ^4.0
- cakephp/plugin-installer: *
Requires (Dev)
README
这是 PGBI/cakephp3-soft-delete 的分支
目的
此 Cakephp 插件使您可以将模型设置为软删除。当进行软删除时,实体实际上并未从数据库中删除。相反,记录上设置了一个 deleted
时间戳。
要求
此插件是为 cakephp 4.x 开发的。
安装
您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。
更新您的 composer 文件以包含此插件
composer require ealus/cakephp-soft-delete
配置
加载插件
// 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 插件正确处理。
- 软删除将像往常一样级联到相关模型。如果相关模型也使用 SoftDelete 特性,则它们也将被软删除。
- 软删除记录将被排除在计数器缓存之外。