README

Laravel 模型版本控制变得简单

跟踪所有模型更改并恢复到之前的版本。

// Restore to the previous change
$content->previousVersion()->revert();

// Get model from a version
$oldModel = Version::find(100)->getModel();

您可以通过 composer 安装

composer require mpociot/versionable

运行迁移。

php artisan migrate --path=vendor/mpociot/versionable/src/migrations

或者，发布迁移。

php artisan vendor:publish --provider="Mpociot\Versionable\Providers\ServiceProvider" --tag="migrations"

然后自定义并运行它们。

php artisan migrate

让想要设置在版本控制下的模型使用 VersionableTrait。

class Content extends Model {
	
	use Mpociot\Versionable\VersionableTrait;
	
}

就这样！

每次更新模型时，都会在数据库中存储包含先前属性的新版本。

所有时间戳和可选的软删除时间戳将被忽略。

有时您不希望在模型上的每个属性更改时创建版本。例如，您的用户模型可能有一个 last_login_at 属性。我敢肯定您不希望在用户登录时为用户模型创建新版本。

要排除特定属性从版本控制，请向您的模型添加一个名为 dontVersionFields 的新数组属性。

class User extends Model {
	
	use Mpociot\Versionable\VersionableTrait;
	
	/**
	 * @var array
	 */
	protected $dontVersionFields = [ 'last_login_at' ];

}

有时您可能希望将隐藏字段包含在版本数据中。您可能在模型中用 visible 或 hidden 属性隐藏了这些字段。

您可以通过将这些字段添加到版本化模型的 versionedHiddenFields 属性中，将项目中通常隐藏的字段保存在版本数据中。

class User {

    use VersionableTrait;

    // Typically hidden fields
    protected $hidden = ['email', 'password'];

    // Save these hidden fields
    protected $versionedHiddenFields = ['email', 'password'];

}

您可以通过为版本化模型设置 $keepOldVersions 属性来控制每个模型存储的版本的最大数量。默认情况下，将没有限制，并保存所有版本。根据您的应用程序，这可能导致版本非常多，因此您可能想要限制存储的版本数量。

您可以通过设置版本化模型上的 $keepOldVersions 属性来做到这一点。

class User {

    use VersionableTrait;

    // Keep the last 10 versions.
    protected $keepOldVersions = 10;

}

要检索所有存储的版本，请使用模型上的 versions 属性。

由于这是一个 MorphMany 关系，因此此属性可以像访问其他 Laravel 关系一样访问。

$model->versions;

如果您想知道两个版本之间确切发生了什么变化，请使用版本模型的 diff 方法。

diff 方法需要一个版本模型作为参数。这定义了要比较的版本。如果没有提供版本，它将使用当前版本。

/**
 * Create a diff against the current version
 */
$diff = $page->previousVersion()->diff();

/**
 * Create a diff against a specific version
 */
$diff = $page->currentVersion()->diff( $version );

结果将是一个关联数组，其中属性名称作为键，不同的属性值。

保存版本非常酷，但真正的好处是能够回滚到特定版本。

有多种方法可以实现这一点。

回滚到上一个版本

您可以使用以下方法轻松回滚到当前活动版本之前的版本

$content->previousVersion()->revert();

回滚到特定版本 ID

您还可以使用以下方法回滚到模型特定版本的特定 ID

$revertedModel = Version::find( $version_id )->revert();

在某些情况下，您可能希望完全禁用特定模型当前请求的版本控制。

您可以通过在可版本化的模型上使用 disableVersioning 和 enableVersioning 方法来完成此操作。

$user = User::find(1);
$user->disableVersioning();

// This will not create a new version entry.
$user->update([
    'some_attribute' => 'changed value'
]);

有时我们希望模型版本存储在不同的表中。默认情况下，版本存储在由 Mpociot\Versionable\Version::$table 定义的 'versions' 表中。

要使用不同的表来存储某些模型的版本，我们必须更改表名。为此，创建一个扩展 Mpociot\Versionable\Version 的模型，并将 $table 属性设置为另一个表名。

class MyModelVersion extends Version
{
    $table = 'mymodel_versions';
    // ...
}

在您希望使用此特定版本表的模型中，使用 VersionableTrait 特性，并添加属性 $versionClass，其值为特定的版本模型。

class MyModel extends Eloquent
{
    use VersionableTrait ;
    protected $versionClass = MyModelVersion::class ;
    // ...
}

并且不要忘记为此版本表创建迁移，与默认版本表完全相同。

Versionable 是在 MIT 许可证条款下免费分发的软件。