Keep a record of changes to models in your application. If a user changes the name of a product from A to B, that change will be stored in a Change
model and stored in your database. Only the changed attributes are stored. You can then use this to retrieve the model's history, including which user made the change.
composer require audunru/model-history
Note: Changes are stored in a table called history
. You can change this in the configuration, but you will have to publish the configuration before publishing and running the migrations.
php artisan vendor:publish --tag=model-history-migrations
php artisan migrate
Add the MakesChanges
trait to your User
model:
namespace App\Models;
use audunru\ModelHistory\Traits\MakesChanges;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use MakesChanges;
Add the HasHistory
trait to any model where you want to track changes:
namespace App\Models;
use audunru\ModelHistory\Traits\HasHistory;
use Illuminate\Database\Eloquent\Model;
class Product extends Model
{
use HasHistory;
Assuming that you've added the HasHistory
trait to a model named Product
, you can retrieve the changes like this:
$product = Product::create([
'description' => 'Old description',
]);
$product->update([
'description' => 'New description',
]);
dump($product->changes);
Publish the configuration file by running:
php artisan vendor:publish --tag=model-history-config
Available options:
/*
* Table where the "Change" model will be stored
*/
'history_table_name' => 'history',
/*
* Eager load the change model's owner
*/
'eager_load_owner' => true,
/*
* Eager load the change model's model
*/
'eager_load_model' => false,
/*
* Date format used when returning the Change model as JSON
*/
'date_format' => 'Y-m-d H:i:s',
Run tests:
composer test