askedio / laravel5-soft-cascade
Laravel级联软删除与恢复
Requires
- php: ^8.2
- illuminate/container: ^10.0|^11.0
- illuminate/database: ^10.0|^11.0
- illuminate/events: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^10.0|^11.0
- dev-master
- 11.0.0
- 10.0.x-dev
- 10.0.0
- 9.0.x-dev
- 9.0.0
- 8.1.0
- 8.0.x-dev
- 8.0.0
- 7.0.x-dev
- 7.0.2
- 7.0.1
- 7.0.0
- 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
This package is auto-updated.
Last update: 2024-09-14 16:13:42 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
测试
我已经编写了一些非常基本的测试,当然还需要做更多的工作。如果您认为这很有用,请通过测试其他数据库或编写更好的单元测试来帮助,因为我必须继续前进。
问题 & 贡献
我将使用 MySQL 在新的 API 中使用此功能,因此我将解决与我使用相关的问题。如果您发现 MySQL 中存在问题,请报告问题,我将修复它。
如果您使用的是其他数据库并且遇到问题,请通过提交拉取请求来贡献。我没有时间测试其他数据库,但假设所有数据库都应该正常工作。