overtrue / laravel-versionable
Make Laravel model versionable.
Fund package maintenance!
overtrue
Installs: 51 170
Dependents: 0
Suggesters: 0
Security: 0
Stars: 373
Watchers: 10
Forks: 33
Open Issues: 1
Requires
- php: ^8.0.2
- doctrine/dbal: ^3.0
- jfcherng/php-diff: ^6.11
- laravel/framework: ^9.0|^10.0
- rogervila/array-diff-multidimensional: ^2.1
Requires (Dev)
- brainmaestro/composer-git-hooks: dev-master
- laravel/pint: ^1.5
- mockery/mockery: ^1.4
- orchestra/testbench: ^9.0
- phpunit/phpunit: ^10.0
README
⏱️ Make Laravel model versionable.
It's a minimalist way to make your model support version history, and it's very simple to roll back to the specified version.
Requirement
- PHP >= 8.0.2
- laravel/framework >= 9.0
Features
- Keep the specified number of versions.
- Whitelist and blacklist for versionable attributes.
- Easily roll back to the specified version.
- Record only changed attributes.
- Easy to customize.
Installing
composer require overtrue/laravel-versionable -vvv
Optional, you can publish the config file:
php artisan vendor:publish --provider="Overtrue\LaravelVersionable\ServiceProvider" --tag=config
And if you want to custom the migration of the versions table, you can publish the migration file to your database path:
php artisan vendor:publish --provider="Overtrue\LaravelVersionable\ServiceProvider" --tag=migrations
After you published the migration files, please update
'migrations' => false
in the config fileconfig/versionable.php
to disable load the package migrations.
Then run this command to create a database migration:
php artisan migrate
Usage
Add Overtrue\LaravelVersionable\Versionable
trait to the model and set versionable attributes:
use Overtrue\LaravelVersionable\Versionable; class Post extends Model { use Versionable; /** * Versionable attributes * * @var array */ protected $versionable = ['title', 'content']; // Or use blacklist //protected $dontVersionable = ['created_at', 'updated_at']; <...> }
Versions will be created on vensionable model saved.
$post = Post::create(['title' => 'version1', 'content' => 'version1 content']); $post->update(['title' => 'version2']);
Get versions
$post->versions; // all versions $post->latestVersion; // latest version // or $post->lastVersion; $post->versions->first(); // first version // or $post->firstVersion; $post->versionAt('2022-10-06 12:00:00'); // get version from a specific time // or $post->versionAt(\Carbon\Carbon::create(2022, 10, 6, 12));
Reversion
Reversion a model instance to the specified version:
$post->getVersion(3)->revert(); // or $post->revertToVersion(3);
Reversion without saving
$version = $post->versions()->first(); $post = $version->revertWithoutSaving();
Remove versions
// soft delete $post->removeVersion($versionId = 1); $post->removeVersions($versionIds = [1, 2, 3]); $post->removeAllVersions(); // force delete $post->forceRemoveVersion($versionId = 1); $post->forceRemoveVersions($versionIds = [1, 2, 3]); $post->forceRemoveAllVersions();
Restore deleted version by id
$post->restoreTrashedVersion($id);
Temporarily disable versioning
// create Post::withoutVersion(function () use (&$post) { Post::create(['title' => 'version1', 'content' => 'version1 content']); }); // update Post::withoutVersion(function () use ($post) { $post->update(['title' => 'updated']); });
Custom Version Store strategy
You can set the following different version policies through property protected $versionStrategy
:
Overtrue\LaravelVersionable\VersionStrategy::DIFF
- Version content will only contain changed attributes (default strategy).Overtrue\LaravelVersionable\VersionStrategy::SNAPSHOT
- Version content will contain all versionable attributes values.
Show diff between two versions
$diff = $post->getVersion(1)->diff($post->getVersion(2));
$diff
is a object Overtrue\LaravelVersionable\Diff
, it based on jfcherng/php-diff.
You can render the diff to many formats, and all formats result will be like follows:
[ $attribute1 => $diffOfAttribute1, $attribute2 => $diffOfAttribute2, ... $attributeN => $diffOfAttributeN, ]
toArray()
$diff->toArray(); // [ "name" => [ "old" => "John", "new" => "Doe", ], "age" => [ "old" => 25, "new" => 26, ], ]
Other formats
toArray(array $differOptions = [], array $renderOptions = []): array toText(array $differOptions = [], array $renderOptions = []): array toJsonText(array $differOptions = [], array $renderOptions = []): array toContextText(array $differOptions = [], array $renderOptions = []): array toHtml(array $differOptions = [], array $renderOptions = []): array toInlineHtml(array $differOptions = [], array $renderOptions = []): array toJsonHtml(array $differOptions = [], array $renderOptions = []): array toSideBySideHtml(array $differOptions = [], array $renderOptions = []): array
Note
$differOptions
and$renderOptions
are optional, you can set them following the README of jfcherng/php-diff.
❤️ Sponsor me
如果你喜欢我的项目并想支持它,点击这里 ❤️
Project supported by JetBrains
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
Contributing
You can contribute in one of three ways:
- File bug reports using the issue tracker.
- Answer questions or fix bugs on the issue tracker.
- Contribute new features or update the wiki.
The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.
License
MIT