README

为 Laravel 提供易于使用的模型版本化

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

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

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

要将 Versionable 添加到您的项目中，只需将其添加到您的 composer.json 中。

"develoopin/versionable": "~3.0"

然后运行 composer install 或 composer update。

或者如果您愿意，运行 composer require develoopin/versionable 。

运行迁移来创建将保存所有版本信息的 "versions" 表。

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

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

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

这就完成了！

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

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

有时您不希望在模型上的属性每次更改时都创建版本。例如，您的 User 模型可能有一个 last_login_at 属性。我非常确信您不希望在用户每次登录时都创建新的 User 模型版本。

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

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

}

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

您可以通过在版本化模型上设置 $keepOldVersions 属性来实现这一点。

class User {

    use VersionableTrait;

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

}

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

此属性也可以像任何其他 Laravel 关系一样访问，因为它是一个 MorphMany 关系。

$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'
]);

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

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

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

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

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

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

Versionable 是在 MIT 许可协议下免费分发的软件。