README

不幸的是，此包现已停止开发。
请查看Varbox (Laravel 管理面板) 以获取此功能以及更多功能。

购买: https://varbox.io/buy
文档: https://varbox.io/docs
演示: https://demo.varbox.test/admin
仓库 https://github.com/VarboxInternational/varbox

谢谢！

为任何 Eloquent 模型及其关系创建版本

概述
安装
设置
使用
自定义
事件

概述

此包允许您为任何 Eloquent 模型记录及其底层关系创建版本。

创建版本时，它将存储在 revisions 数据库表中。
在模型更新时，使用 updated Eloquent 事件自动创建版本
也可以通过使用 saveAsRevision() 手动创建版本
当记录被强制删除时，所有版本也会自动删除，使用 deleted Eloquent 事件

如前所述，此包能够对整个关系及其模型记录进行版本控制。

酷的地方在于，如果它们在模型记录的生命周期中被强制删除，它还可以从头开始重新创建这些关系记录。

可以版本控制的关系类型：hasOne，morphOne，hasMany，morphMany，belongsToMany，morphToMany

安装

通过 Composer 安装包（适用于 Laravel 6.0 及以上）

composer require neurony/laravel-revisions

通过 Composer 安装包（适用于 Laravel 5.8）

composer require neurony/laravel-revisions:3.1.0

通过 Composer 安装包（适用于 Laravel 5.7 及以下）

composer require neurony/laravel-revisions:2.0.0

使用以下命令发布配置文件

php artisan vendor:publish --provider="Neurony\Revisions\ServiceProvider" --tag="config"

使用以下命令发布迁移文件

php artisan vendor:publish --provider="Neurony\Revisions\ServiceProvider" --tag="migrations"

迁移文件发布后，您可以通过运行以下命令创建 revisions 表

php artisan migrate

设置

步骤 1

您的 Eloquent 模型应使用 Neurony\Revisions\Traits\HasRevisions 特性和 Neurony\Revisions\Options\RevisionOptions 类。

该特性包含一个抽象方法 getRevisionOptions()，您必须自己实现。

以下是如何实现该特性的示例

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Neurony\Revisions\Options\RevisionOptions;
use Neurony\Revisions\Traits\HasRevisions;

class YourModel extends Model
{
    use HasRevisions;

    /**
     * Get the options for revisioning the model.
     *
     * @return RevisionOptions
     */
    public function getRevisionOptions(): RevisionOptions
    {
        return RevisionOptions::instance();
    }
}

步骤 2

在 revisions.php 配置文件中，为 user_model 配置键写入您的 User 模型类的完整命名空间。

默认情况下，此值是Laravel的User模型类的FQN（完全限定名）（\App\User）。如果您应用程序没有用户的概念，也可以将其留为NULL。

此位由Neurony\Revisions\Traits\HasRevisions特质使用，以了解谁创建了哪些修订。

使用方法

获取修订版本

您可以通过使用存在于Neurony\Revisions\Traits\HasRevisions特质上的revisions()多对多关系来获取模型记录的修订版本。

$model = YourModel::find($id);

$revisions = $model->revisions;

创建修订版本（自动创建）

一旦您在Eloquent模型中使用了Neurony\Revisions\Traits\HasRevisions特质，每次更新模型记录时，都会自动创建包含其原始属性值的修订版本，这是通过使用updated Eloquent事件实现的。

// model is state 1
$model = YourModel::find($id);

// model is state 2
// a revision containing the model's state 1 is created 
$model->update(...);

或者，您也可以通过使用created Eloquent事件，在创建新模型记录时存储每个修订版本。
（请参阅自定义）

创建修订版本（手动创建）

如果您需要，还可以通过使用Neurony\Revisions\Traits\HasRevisions特质中的saveAsRevision()方法来手动创建修订版本。

$model = YourModel::find($id);

// a new entry is stored inside the 'revisions' database table
// reflecting the current state of that model record
$model->saveAsRevision();

回滚到以前的修订版本

您可以通过使用rollbackToRevision()方法将模型记录回滚到其以前的某个修订版本。

// model is state 1
$model = YourModel::find($id);
$revision = $model->revisions()->latest()->first();

// model is now in state 0
$model->rollbackToRevision($revision);

自定义

在创建时启用修订

默认情况下，在创建新的模型记录时，不会创建修订版本，因为记录是新的，它处于第一个状态。但是，如果您希望在创建模型记录时创建修订版本，您可以通过在getRevisionOptions()方法的定义中使用enableRevisionOnCreate()方法来实现。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->enableRevisionOnCreate();
}

限制修订版本的数量

您可以通过在getRevisionOptions()方法的定义中使用limitRevisionsTo()方法来限制每个模型记录可以拥有的修订版本数量。

这可以防止一个频繁更新的记录出现成千上万的修订版本。

当达到限制时，在创建新的（最新）修订版本后，脚本将自动删除该模型记录最旧的修订版本。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->limitRevisionsTo(100);
}

仅修订某些字段

如果您不想修订模型的所有字段（属性），您可以通过在getRevisionOptions()方法的定义中使用fieldsToRevision()方法手动指定在创建新修订版本时希望存储哪些字段。

请注意，省略的字段在创建修订版本时不会存储，但在回滚到修订版本时，那些被忽略的字段将变为空/空值。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->fieldsToRevision('title', 'content');
}

排除某些字段进行修订

与fieldsToRevision()方法相反，如果您在修改Eloquent模型时想排除某些字段，请在使用getRevisionOptions()方法时使用fieldsToNotRevision()方法。

请注意，fieldsToRevision()方法优先于fieldsToNotRevision()方法。
不要在同一个getRevisionOptions方法的定义中使用这两个方法。

请注意，省略的字段在创建修订版本时不会存储，但在回滚到修订版本时，那些被忽略的字段将变为空/空值。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->fieldsToNotRevision('title', 'content');
}

创建修订时包含时间戳

默认情况下，创建修订时，实际模型的时间戳会自动排除在实际修订数据之外。

如果您想在创建修订时存储模型的时间戳，请在使用getRevisionOptions()方法时使用withTimestamps()方法。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->withTimestamps();
}

与模型记录一起修订关系

通常，您会希望创建模型记录的时间副本，这包括修订其关系（尤其是子关系）。

您可以通过在getRevisionOptions方法的定义中使用relationsToRevision()方法来指定要修订与模型记录一起的关系。

请注意，当回滚模型记录到过去修订时，指定的关系也将回滚到当时修订的状态（这包括如果在此过程中强制删除了关系记录，则从头开始重新创建关系记录，或者删除直到修订检查点之前添加的所有相关记录）。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->relationsToRevision('comments', 'author');
}

回滚时禁用创建修订

默认情况下，当回滚到过去修订时，会自动创建一个新的修订。这个新修订包含回滚发生之前模型记录的状态。

您可以通过在getRevisionOptions方法的定义中使用disableRevisioningWhenRollingBack()方法来禁用此行为。

/**
 * Get the options for revisioning the model.
 *
 * @return RevisionOptions
 */
public function getRevisionOptions(): RevisionOptions
{
    return RevisionOptions::instance()
        ->disableRevisioningWhenRollingBack();
}

事件

修订功能包含两个Eloquent事件：revisioning和revisioned

您可以像实现Laravel框架附带的其他任何Eloquent事件一样实现这些事件。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Neurony\Revisions\Options\RevisionOptions;
use Neurony\Revisions\Traits\HasRevisions;

class YourModel extends Model
{
    use HasRevisions;

    /**
     * Boot the model.
     *
     * @return RevisionOptions
     */
    public static function boot()
    {
        parent::boot();

        static::revisioning(function ($model) {
            // your logic here
        });

        static::revisioned(function ($model) {
            // your logic here
        });
    }
    
    /**
     * Get the options for revisioning the model.
     *
     * @return RevisionOptions
     */
    public function getRevisionOptions(): RevisionOptions
    {
        return RevisionOptions::instance();
    }
}

致谢

安全

如果您发现任何安全相关的问题，请通过电子邮件andrei.badea@neurony.ro而不是使用问题跟踪器。

许可证

MIT许可证（MIT）。有关更多信息，请参阅LICENSE。

变更日志

有关最近更改的更多信息，请参阅CHANGELOG。

贡献

有关详细信息，请参阅CONTRIBUTING。

neurony / laravel-revisions

维护者

详细信息