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 karl456/laravel-revisions

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

composer require karl456/laravel-revisions:3.1.0

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

composer require karl456/laravel-revisions:2.0.0

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

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

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

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

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

php artisan migrate

设置

步骤1

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

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

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

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Karl456\Revisions\Options\RevisionOptions;
use Karl456\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模型类的全称（\App\User）。如果您应用程序没有用户的概念，也可以将其留为NULL。

这部分由Karl456\Revisions\Traits\HasRevisions特性用来知道谁创建了哪个版本。

使用

获取版本

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

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

$revisions = $model->revisions;

创建版本（自动）

一旦您在Eloquent模型中使用了Karl456\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事件，在每次创建新的模型记录时存储一个版本
（请参阅自定义）

创建版本（手动）

如果您需要，也可以手动创建修订版，通过使用来自 Karl456\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() 方法手动指定在创建新修订版时希望存储的字段。

请注意，省略的字段在创建修订版时不会存储，但在回滚到修订版时，这些被忽略的字段将变为实际模型记录的 null / 空值。

/**
 * 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 方法定义中使用这两个方法。

请注意，省略的字段在创建修订版时不会存储，但在回滚到修订版时，这些被忽略的字段将变为实际模型记录的 null / 空值。

/**
 * 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

您可以在 Eloquent 模型中实现这些事件，就像实现 Laravel 框架中提供的任何其他 Eloquent 事件一样。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Karl456\Revisions\Options\RevisionOptions;
use Karl456\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 了解详细信息。

karl456 / laravel-revisions

维护者

详细信息