makidizajnerica/laravel-snapshoter

Laravel model snapshoter.

v3.0 2022-09-16 08:10 UTC

Requires

• php: >=8.0
• laravel/framework: >=9.0

Requires (Dev)

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

MIT

• Nemanja Marijanovic

• framework
• php
• snapshot
• model
• laravel
• models
• eloquent

README

Laravel model snapshoter. Make snapshots for the models, revert model state to previous snapshot.

Installation

composer require makidizajnerica/laravel-snapshoter

After that be sure to run migrations to generate snapshots table:

php artisan migrate

Then publish config file snapshoter.php using:

php artisan vendor:publish --tag=snapshoter-config

Usage

Your model needs to implement MakiDizajnerica\Snapshoter\Contracts\Snapshotable and also to use MakiDizajnerica\Snapshoter\HasSnapshots trait. Next define snapshotFields method that will return model attributes you want to save to the snapshots:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use MakiDizajnerica\Snapshoter\HasSnapshots;
use MakiDizajnerica\Snapshoter\Contracts\Snapshotable as SnapshotableContract;

class Project extends Model implements SnapshotableContract
{
    use HasSnapshots;

    /**
     * Get attributes for the snapshot.
     *
     * @return array<string, mixed>
     */
    public function snapshotAttributes(): array
    {
        return $this->only([
            'name',
            'description',
            'start_at',
            'end_at',
        ]);
    }

    // ...
}

You will then have some methods available on your model:

<?php

use App\Models\Project;
use MakiDizajnerica\Snapshoter\Models\Snapshot;

// Make snapshot for the model
$project = Project::first();
$project->makeSnapshot();
// or
snapshoter($project);

// Revert model's state to previous snapshot
$project->revertToPreviousSnapshot();

// Revert model's state to the snapshot from a few steps back
$project->revertToPreviousSnapshot(3);

// You can also pass Snapshot instance
$snapshot = $project->snapshots()->first();
$project->revertToSnapshot($snapshot);

If you want to create, update or save your model with the snapshot, you can use:

<?php

use App\Models\Project;

// Create model with initial snapshot
$project = Project::createWithSnapshot([/* ... */]);

// Update model and make snapshot
$project->updateWithSnapshot([/* ... */]);

// Save model and make snapshot
$project->fill([/* ... */])->saveWithSnapshot();

Another option would be to use observer and automatically make snapshot on model create or update:

<?php

namespace App\Observers;

use App\Models\Project;

class ProjectObserver
{
    /**
     * Handle the Project "created" event.
     *
     * @param  \App\Models\Project $project
     * @return void
     */
    public function created(Project $project)
    {
        $project->makeSnapshot();
    }

    /**
     * Handle the Project "updated" event.
     *
     * @param  \App\Models\Project $project
     * @return void
     */
    public function updated(Project $project)
    {
        $project->makeSnapshot();
    }
}

Author

Nemanja Marijanovic ([e-mail])

Licence

Copyright © 2021, Nemanja Marijanovic [e-mail]

All rights reserved.

For the full copyright and license information, please view the LICENSE file that was distributed within the source root of this package.