askedio/laravel5-soft-cascade

Laravel级联软删除与恢复

11.0.0 2024-03-14 14:57 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()); 
}

支持的数据库

  • MySQL
  • PostgreSQL
  • SQLite
  • SQL Server

测试

我已经编写了一些非常基本的测试,当然还需要做更多的工作。如果您认为这很有用,请通过测试其他数据库或编写更好的单元测试来帮助,因为我必须继续前进。

问题 & 贡献

我将使用 MySQL 在新的 API 中使用此功能,因此我将解决与我使用相关的问题。如果您发现 MySQL 中存在问题,请报告问题,我将修复它。

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