cape-and-bay/versionable

Laravel Drafts tool for models

v1.0.1 2023-01-18 17:10 UTC

Requires

• php: ^8.1

Requires (Dev)

• orchestra/testbench: ^7.18
• phpunit/phpunit: ^9.5

MIT

• Chrys Ugwu

• versionable
• capeandbay

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

1. PHP >= 8.1
2. laravel/framework >= 9.0

Installing

composer require cape-and-bay/versionable -vvv

Then run this command to create a database migration:

php artisan migrate

Usage

Add CapeAndBay\Versionable\Versionable trait to the model that you want to be versioned:

use CapeAndBay\Versionable\Versionable;

class Post extends Model
{
    use Versionable;

    # Prevents versioning Post if only the "is_active" column is updated.
    protected array $dont_version = ['is_active'];
}

Versions will be created on vensionable model saved.

$post = Post::create(['title' => 'version1', 'content' => 'version1 content']);
$post->update(['title' => 'version2']);

You can prevent a new version of model from being created by return false on onNewVersionCreate. to use this method, your model must implement the VersionableInterface in conjunction with Versionable trait:

use CapeAndBay\Versionable\Versionable;
use CapeAndBay\Versionable\VersionableInterface;
use Illuminate\Database\Eloquent\Model;

class User extends Model implements VersionableInterface
{
    use Versionable;
    
    public function onNewVersionCreate(Model $model) : bool
    {
        // Create new version if email is not "[e-mail]"
        return $model->email !== '[e-mail]';
    }
}

Get versions

$post->versions; // all versions
$post->latestVersion(); // latest version
$post->versions->first(); // first version