guglielmoseminara/laravel-soft-cascade

Laravel 软删除级联与恢复

6.0.0 2021-03-24 10:52 UTC

README

Header

Build Status Codacy Badge Codacy Badge StyleCI Badge

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()); 
}

支持的 PHP 版本

  • >=7.1.13

支持的数据库

  • MySQL
  • PostgreSQL
  • SQLite
  • SQL Server

测试

我编写了一些非常基本的测试,肯定还需要做更多。如果你觉得这很有用,请通过测试其他数据库或编写更好的单元测试来帮助,因为我必须继续前进。

问题 & 贡献

我将使用 MySQL 在一个新的 API 中使用它,所以与我使用相关的任何问题都将得到解决。如果你发现与 MySQL 相关的问题,请报告它,我将修复它。

如果你使用的是其他数据库并且有问题,请通过提交拉取请求来贡献。我没有时间测试其他数据库,但假设所有都会工作。