README

是否希望为项目中的任何模型保留修订历史，而不必为此做任何工作。通过简单地从您的模型扩展 revisionable，您就可以立即拥有这样的功能，并且能够显示类似这样的历史记录

Chris 将标题从 'Something' 更改为 'Something else'
Chris 将类别从 'News' 更改为 'Breaking news'
Matt 将类别从 'Breaking news' 更改为 'News'

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

Revisionable 是一个 Laravel 扩展包，允许您在不思考的情况下为模型保留修订历史。有关背景和更多信息，请参阅这篇文章

与第三方 Auth / Eloquent 扩展一起使用

Revisionable 支持由 Sentry by Cartalyst 驱动的 Auth

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

安装

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

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

"ciyin/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.
}

存储软删除

默认情况下，如果您的模型支持软删除，revisionable 会将此以及任何恢复存储为模型上的更新。

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

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

存储创建

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

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

protected $revisionCreationsEnabled = true;

格式输出

您可以使用 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，以下示例将显示 'Nothing' 如果值为空，或者如果存在实际值

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' 标签。

ciyin / revisionable

维护者

详情