README

这是对已废弃的 abandoned VentureCraft/revisionable 项目的分支。

兼容 L5.8

不是很好吗？在项目中为任何模型保留修订历史，无需为此做任何工作。只需从您的模型扩展 revisionable，您就可以立即拥有这样的功能，并且能够显示类似这样的历史

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

因此，您不仅可以查看发生的事情的历史，还可以查看谁做了什么，因此有问责制。

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

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

Revisionable 支持 Cartalyst 的 Auth 驱动的 Auth

Sentry.
Sentinel.

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

安装

Revisionable 可以通过 composer 安装，详情请参阅 packagist，在此。

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

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

运行 composer update 下载包

php composer.phar update

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

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

Laravel 4.x 用户

php artisan migrate --package=edujugon/revisionable

如果您将经常完全迁移上下文（使用 migrate:refresh），您可以做的另一件事是将迁移文件从包复制到您的 app/database 文件夹，并将类名从 CreateRevisionsTable 更改为类似 CreateRevisionTable 的名称（不带 's'，否则您将收到一个错误，表示存在重复的类）

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

实现

新的基于特性的实现

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

namespace MyApp\Models;

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

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

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

特性要求PHP >= 5.4

基于类的传统实现

基于特性的新方法与现有的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;

格式输出

您可以在模型中使用（并鼓励使用）eloquent访问器来设置值的输出，有关访问器的更多信息，请参阅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()。

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

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

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

edujugon / revisionable

维护者

详细信息