Simple to use, customizable, Laravel Model history tracking utility trait
This package can work independently of the Enso ecosystem.
For live examples and demos, you may visit laravel-enso.com
Comes pre-installed in Enso.
To install outside of Enso:
composer require laravel-enso/historytracker
The trait helps keep track of the changes made to a model by saving a snapshot for each relevant update of the model to a different 'history' table.
The records in the history table are linked via FK to the original model. Setting a FK constraint on the DB column may be set if necessary.
You can choose the attributes you want to track from the model by declaring them as fillable in the history model.
When the model is created, an initial snapshot of the desired attributes is saved. When the model is updated, if any one of the tracked attributes has changed, a new snapshot/history entry is persisted.
Create a histories table, such as
model_histories- where model is what you need to keep track of.
Create a corresponding history model, such as
ModelHistoryand add as fillable the attributes you want tracked:
protected $fillable = ['tracked', 'attributes', 'list'];
Don't forget to also have the FK column for the relationship to the tracked model.
- Use the trait in the tracked model:
- Add the
$historyModelproperty to the tracked model:
protected $historyModel = ModelHistory::class;
The trait also defines a relationship to the history model instances,
so you can access the snapshots by calling
are welcome. Pull requests are great, but issues are good too.
This package is released under the MIT license.