Revisionable 项目使用教程

Revisionable 项目使用教程

revisionableEasily create a revision history for any laravel model项目地址:https://gitcode.com/gh_mirrors/re/revisionable

项目介绍

Revisionable 是一个为 Laravel 模型提供版本历史记录功能的扩展包。通过在模型中简单地添加 RevisionableTrait，您可以立即为任何模型实现版本历史记录功能，记录模型的变更历史，包括谁在何时进行了哪些修改。

项目快速启动

要开始使用 Revisionable，首先需要通过 Composer 安装该包：

composer require venturecraft/revisionable

安装完成后，在需要记录版本历史的模型中引入 RevisionableTrait：

namespace App;

use Illuminate\Database\Eloquent\Model;
use Venturecraft\Revisionable\RevisionableTrait;

class Article extends Model
{
    use RevisionableTrait;
}

接下来，运行迁移命令以创建存储版本历史记录的数据表：

php artisan migrate

应用案例和最佳实践

启用版本记录

默认情况下，Revisionable 会记录所有字段的变更。如果您希望某些字段不被记录，可以使用 $dontKeepRevisionOf 属性：

class Article extends Model
{
    use RevisionableTrait;

    protected $dontKeepRevisionOf = ['category_id'];
}

限制版本记录数量

您可以通过设置 $historyLimit 属性来限制版本记录的数量：

class Article extends Model
{
    use RevisionableTrait;

    protected $historyLimit = 500;
}

记录创建操作

默认情况下，创建操作不会被记录为版本。如果您希望记录创建操作，可以设置 $revisionCreationsEnabled 属性：

class Article extends Model
{
    use RevisionableTrait;

    protected $revisionCreationsEnabled = true;
}

典型生态项目

Revisionable 可以与其他 Laravel 生态系统中的项目结合使用，例如：

• Laravel Auditing: 另一个用于记录模型变更历史的扩展包，可以与 Revisionable 结合使用以提供更全面的审计功能。
• Laravel Backpack: 一个用于快速构建管理界面的扩展包，可以集成 Revisionable 以在管理界面中显示版本历史记录。

通过这些扩展包的结合使用，可以为您的 Laravel 应用提供更强大的版本控制和审计功能。

revisionableEasily create a revision history for any laravel model项目地址:https://gitcode.com/gh_mirrors/re/revisionable