agilukm / laravel-soft-cascade
Laravel 级联软删除与恢复
Requires
- php: ^7.2.5
- illuminate/container: ^7.0
- illuminate/database: ^7.0
- illuminate/events: ^7.0
- illuminate/support: ^7.0
Requires (Dev)
- codacy/coverage: dev-master
- orchestra/testbench: ^5.0
- phpunit/phpunit: ^8.4|^9.0
- dev-master
- 7.0.x-dev
- 7.0.0
- 6.1
- 6.0.x-dev
- 6.0.1
- 6.0.0
- 5.8.x-dev
- 5.8.0
- 5.7.x-dev
- 5.7.0
- 5.6.x-dev
- 5.6.5
- 5.6.4
- 5.6.3
- 5.6.2
- 5.6.1
- 5.6.0
- 5.5.x-dev
- 5.5.17
- 5.5.16
- 5.5.15
- 5.5.14
- 5.5.13
- 5.5.12
- 5.5.11
- 5.5.10
- 5.5.9
- 5.5.8
- 5.5.7
- 5.5.6
- 5.5.5
- 5.5.4
- 5.5.3
- 5.5.2
- 5.5.1
- 5.5.0
- 2.6
- 2.5
- 2.4
- 2.3
- 2.2
- 2.1
- 2.0
- 1.8
- 1.7
- 1.6
- 1.5
- 1.4
- 1.3
- 1.2
- 1.1
- 1.0
- dev-develop
This package is not auto-updated.
Last update: 2024-09-20 23:44:06 UTC
README
Laravel/Lumen 级联软删除与恢复
当使用 Laravel 或 Lumen SoftDeletes 功能时,级联删除和恢复。
我为什么需要它?
使软删除和恢复关系变得简单。
如果你喜欢像 MySQL 级联删除这样的功能,但想使用 Laravel 的 SoftDeletes 功能,你需要进行一些额外的步骤,以确保你的关系被正确删除或恢复。
此软件包旨在用定义你想要级联的关系的简单数组来替换这些步骤。
安装
使用 composer 安装
composer require askedio/laravel-soft-cascade
从 Laravel 5.5 开始,可以利用自动发现服务提供者的功能。对于 5.5 版本之前的 Laravel,你必须在你的 config/app.php 中注册服务提供者。
Askedio\SoftCascade\Providers\GenericServiceProvider::class,
Lumen 不支持自动发现功能,你应该手动添加提供者。
Askedio\SoftCascade\Providers\LumenServiceProvider::class,
使用
在你的 Model
中启用特性并定义 $softCascade
。 示例。
use \Askedio\SoftCascade\Traits\SoftCascadeTrait;
protected $softCascade = ['profiles'];
对于受限制的关系使用。 示例。
use \Askedio\SoftCascade\Traits\SoftCascadeTrait;
protected $softCascade = ['addresses@restrict'];
$softCascade
是一个包含你的关系名称的数组,在 示例 中,你会看到我们已为该关系定义了 function profiles()
。
嵌套关系通过在相关的 Model
中定义 $softCascade
来工作,就像你可以在 这里 看到的。
定义好你的关系后,你只需简单地触发你的 Model
上的 delete()
或 restore()
,你的关系就会执行相同的任务。
User::first()->delete();
User::withTrashed()->first()->restore();
它还可以与查询构建器一起使用,因为查询构建器监听器在查询之后执行,由于受限制的关系,我们需要使用事务来回滚查询错误。
try {
DB::beginTransaction(); //Start db transaction for rollback query when error
User::limit(2)->delete();
User::withTrashed()->limit(2)->restore();
DB::commit(); //Commit the query
} catch (\Exception $e) {
DB::rollBack(); //Rollback the query
//Optional, if we need to continue execution only rollback transaction and save message on variable
throw new \Askedio\SoftCascade\Exceptions\SoftCascadeLogicException($e->getMessage());
}
支持的数据库
- MySQL
- PostgreSQL
- SQLite
- SQL Server
测试
我已经编写了一些非常基本的测试,当然还需要做更多。如果你觉得这个有用,请通过测试其他数据库或编写更好的单元测试来帮助,因为我必须继续前进。
问题 & 贡献
我将在新的 API 中使用 MySQL,所以与我使用相关的任何问题都将得到解决。如果你发现 MySQL 中的问题,请报告并我将修复它。
如果你使用的是其他数据库并且有问题,请通过提交拉取请求来贡献。我没有时间测试其他数据库,但假设所有都会正常工作。