README

如果您希望在项目中为任何模型保留修订历史，而不必为此做任何工作，那岂不是很好。通过简单地将revisionable从您的模型扩展出来，您就可以立即拥有它，并且能够显示类似于以下的历史记录：

• Chris将标题从'Something'更改为'Something else'
• Chris将类别从'新闻'更改为'突发新闻'
• Matt将类别从'突发新闻'更改为'新闻'

因此，您不仅可以看到发生了什么，还可以看到谁做了什么，这样就有责任了。

Revisionable是一个Laravel包，允许您无需思考即可为模型保留修订历史。有关背景信息和信息，请参阅这篇文章

与第三方Auth / Eloquent扩展一起工作

Revisionable支持由以下Auth提供支持：

• Sentry by Cartalyst.
• Sentinel by Cartalyst.

Revisionable现在也可以作为一个特性使用，因此您的模型可以继续扩展Eloquent，或者任何扩展Eloquent的类（例如Ardent）。

安装

Revisionable可以通过composer安装，详情请见packagist，此处。

将以下内容添加到您的项目的composer.json文件的require部分

"venturecraft/revisionable": "1.*",

运行composer update以下载包

php composer.phar update

最后，您还需要运行包的迁移（Laravel 5.x）

php artisan migrate --path=vendor/venturecraft/revisionable/src/migrations

Laravel 4.x用户

php artisan migrate --package=venturecraft/revisionable

如果您将经常进行完全的迁移（使用migrate:refresh），您可以选择将迁移文件从包中复制到您的app/database文件夹，并将类名从CreateRevisionsTable更改为类似CreateRevisionTable的名称（不带's'，否则您将收到一个错误消息，表明有重复的类）

cp vendor/venturecraft/revisionable/src/migrations/2013_04_09_062329_create_revisions_table.php app/database/migrations/

文档

• 实现
• 更多控制
• 格式输出
• 加载修订历史
• 显示历史记录
• 贡献
• 遇到麻烦了吗？

实现

新的，基于特性的实现

对于您希望保留修订历史的任何模型，请包含revisionable命名空间并在您的模型中使用RevisionableTrait，例如，如果您正在使用另一个可启动的特性，请确保在您的模型中重写boot方法；

namespace MyApp\Models;

class Article extends Eloquent {
    use \Venturecraft\Revisionable\RevisionableTrait;

    public static function boot()
    {
        parent::boot();
    }
}

作为一个特性，revisionable现在可以与标准的Eloquent模型一起使用，或者任何扩展Eloquent的类，例如Ardent。

特性需要PHP >= 5.4

基于类的旧实现

新的基于特性的方法与Revisionable的现有安装向后兼容。您仍然可以使用下面的安装说明，这实际上是一个用于特性的包装器的扩展。

对于您希望保留修订历史的任何模型，请包含revisionable命名空间并扩展revisionable而不是eloquent，例如

use Venturecraft\Revisionable\Revisionable;

namespace MyApp\Models;

class Article extends Revisionable { }

注意，它也适用于命名空间模型。

实现说明

如有需要，您可以通过在您的模型中将 $revisionEnabled 设置为 false 来禁用修订记录。这很有用，如果您想暂时禁用修订记录，或者您想创建自己的基础模型，该模型扩展了可修订性，并且所有模型都扩展了该模型，但您希望关闭某些模型的修订记录。

namespace MyApp\Models;

class Article extends Eloquent {
    use Venturecraft\Revisionable\RevisionableTrait;

    protected $revisionEnabled = false;
}

您还可以通过将 $historyLimit 设置为要保留的修订记录数来在 X 次修订后禁用修订记录。

namespace MyApp\Models;

class Article extends Eloquent {
    use Venturecraft\Revisionable\RevisionableTrait;

    protected $revisionEnabled = true;
    protected $historyLimit = 500; //Stop tracking revisions after 500 changes have been made.
}

为了限制历史记录，但您想要删除旧修订记录而不是停止跟踪修订记录，您可以通过设置 $revisionCleanup 来实现该功能。

namespace MyApp\Models;

class Article extends Eloquent {
    use Venturecraft\Revisionable\RevisionableTrait;

    protected $revisionEnabled = true;
    protected $revisionCleanup = true; //Remove old revisions (works only when used with $historyLimit)
    protected $historyLimit = 500; //Maintain a maximum of 500 changes at any point of time, while cleaning up old revisions.
}

存储软删除

默认情况下，如果您的模型支持软删除，修订记录将存储此记录和任何恢复，作为模型上的更新。

您可以选择忽略删除和恢复，通过将 deleted_at 添加到您的 $dontKeepRevisionOf 数组中。

为了更好地格式化 deleted_at 条目的输出，您可以使用 isEmpty 格式化器（请参见 格式化输出 中的示例）。

存储创建

默认情况下，新模型的创建不会作为修订记录存储。只有模型随后的更改会被存储。

如果您想将创建存储为修订记录，您可以通过在您的模型中添加以下内容来覆盖此行为，将 revisionCreationsEnabled 设置为 true

protected $revisionCreationsEnabled = true;

更多控制

毫无疑问，会有一些情况您不希望只存储模型某些字段的修订历史，这以两种不同的方式得到支持。在您的模型中，您可以选择明确指定您想跟踪哪些字段，其他所有字段将被忽略

protected $keepRevisionOf = array(
    'title'
);

或者，您可以指定您明确不希望跟踪的字段。其他所有字段将被跟踪。

protected $dontKeepRevisionOf = array(
    'category_id'
);

$keepRevisionOf 设置优先于 $dontKeepRevisionOf

事件

每次创建模型修订记录时都会触发一个事件。您可以监听 revisionable.created、
revisionable.saved 或 revisionable.deleted。

// app/Providers/EventServiceProviders.php
public function boot(DispatcherContract $events)
{
    parent::boot($events);

    $events->listen('revisionable.*', function($model, $revisions) {
        // Do something with the revisions or the changed model. 
        dd($model, $revisions);
    });
}

格式输出

您可以使用 eloquent accessors 在您的模型中设置值的输出，请参阅 Laravel 文档 以获取有关访问器的更多信息。以下文档已过时

在您想要控制值输出格式的情况下，例如布尔字段，您可以在模型中设置它们在 $revisionFormattedFields 数组中。例如：

protected $revisionFormattedFields = array(
    'title'  => 'string:<strong>%s</strong>',
    'public' => 'boolean:No|Yes',
    'modified' => 'datetime:m/d/Y g:i A',
    'deleted_at' => 'isEmpty:Active|Deleted'
);

您还可以使用模型中的 $revisionFormattedFieldNames 数组覆盖字段名称输出，例如：

protected $revisionFormattedFieldNames = array(
    'title' => 'Title',
    'small_name' => 'Nickname',
    'deleted_at' => 'Deleted At'
);

当您使用 $revision->fieldName() 输出修订字段名称时，此功能会发挥作用。

字符串

要格式化字符串，只需在值前加上 string: 并确保包含 %s（这是实际值将出现在格式化响应中的位置），例如：

string:<strong>%s</strong>

布尔值

布尔值默认将显示为 0 或 1，这非常平淡无奇，对最终用户来说意义不大，因此可以使用此格式化器输出更美观的内容。在值前加上 boolean: 然后添加您的 false 和 true 选项，用竖线分隔，例如：

boolean:No|Yes

日期时间

默认情况下，日期时间将显示为 Y-m-d H:i:s。在值前加上 datetime: 然后添加您的日期时间格式，例如：

datetime:m/d/Y g:i A

是否为空

此功能基于布尔值，但与测试 true 或 false 值不同，它检查值是否为 null 或空字符串。

isEmpty:No|Yes

这也可以接受 %s 如果您想要输出值，以下示例将显示 '无' 如果值为空，或者如果存在则显示实际值

isEmpty:Nothing|%s

加载修订历史

要加载特定模型的修订历史，只需在该模型上调用 revisionHistory 方法，例如

$article = Article::find($id);
$history = $article->revisionHistory;

显示历史记录

通常，修订历史将包含足够的信息以直接输出变更历史，但在外键更新时，我们需要进行一些映射，并显示比 plan_id 从 3 更改为 1 更好的内容。

为此，有几个辅助方法可以显示更深入的信息，因此您可以显示类似于 Chris 将计划从青铜更改为黄金 的内容。

上述结果来自以下

@foreach($account->revisionHistory as $history )
    <li>{{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}</li>
@endforeach

如果您还启用了创建的修订版本，则可以像这样显示

@foreach($resource->revisionHistory as $history)
  @if($history->key == 'created_at' && !$history->old_value)
    <li>{{ $history->userResponsible()->first_name }} created this resource at {{ $history->newValue() }}</li>
  @else
    <li>{{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}</li>
  @endif
@endforeach

userResponsible()

返回负责进行修订的用户。返回用户模型，如果没有记录用户则返回 null。

加载的用户模型取决于您在 config/auth.php 文件中为 model 变量设置的值。

fieldName()

返回已更新的字段的名称，如果更新的字段是外键（在此阶段，它只是检查字段是否有 _id 后缀），则返回 _id 前面的文本。例如，如果字段是 plan_id，则返回 plan。

记住，您可以通过模型中的 $revisionFormattedFieldNames 数组覆盖字段的输出。

identifiableName()

当值（旧值或新值）是外键关系中的 ID 时使用。

默认情况下，它简单地返回已更新的模型的 ID。您可以根据自己的模型覆盖此方法以返回有意义的内容。例如

use Venturecraft\Revisionable\Revisionable;

class Article extends Revisionable
{
    public function identifiableName()
    {
        return $this->title;
    }
}

oldValue() 和 newValue()

获取更新前或更新后的模型值。如果是外键，则调用 identifiableName()。

未知或无效的外键作为修订版本

在旧值或新版本的值是不再存在的外键或实际上是 null 的情况下，您可以在模型中设置两个变量来控制这些情况下的输出

protected $revisionNullString = 'nothing';
protected $revisionUnknownString = 'unknown';

disableRevisionField()

有时临时禁用一个可修订字段可能很有用，如果您想要保存更新，但不需要保留更改记录。

$object->disableRevisionField('title'); // Disables title

或

$object->disableRevisionField(array('title', 'content')); // Disables title and content

贡献

鼓励并欢迎贡献；为了保持有序，所有错误和请求都应在主要项目的 GitHub issues 标签中打开，在 venturecraft/revisionable/issues

所有拉取请求都应提交到 develop 分支，以便在合并到 master 分支之前进行测试。

遇到麻烦了吗？

如果您在使用此包时遇到问题，很可能会有人遇到相同的问题。您可以查找常见答案的两个地方是

• StackOverflow revisionable 标签
• GitHub Issues

如果您更愿意在公共论坛 StackOverflow 上发布您的问题，请使用 'revisionable' 标签。