devitek/eloquent-loggable

Make your eloquent Model loggable

Make your eloquent Model loggable

, _(*1)

This package provide a simple way to make your Eloquent's model loggable. It works like the Gedmo/Loggable extension for doctrine., _(*2)

Installation

Run :, _(*3)

composer require devitek/eloquent-loggable

Into your config/app.php add the service provider :, _(*4)

'providers' => [
    // Other Service Providers

    Devitek\Laravel\Eloquent\Loggable\EloquentLoggableServiceProvider::class,
],

Get the migration :, _(*5)

php artisan vendor:publish --provider="Devitek\Laravel\Eloquent\Loggable\EloquentLoggableServiceProvider" --tag="migrations"

and then run :, _(*6)

php artisan migrate

How to use it

In your Eloquent model add :, _(*7)

<?php

use \Devitek\Laravel\Eloquent\Loggable;

class MyModel extends Model
{
    use Loggable;

    protected $versioned = [
        'name',
        'other_field',
        'another_field',
        'again_another_field',
    ];

    protected $reason = 'my_reason_field';
}

Now, each time you'll persist your model, all fields that are declared in the versioned property will be checked (if dirty) and then logged., _(*8)

The reason property indicates which field will be used to have a log message. It's not required, by default the log message will be empty. This field will be unset before persist so you can use a dynamic field., _(*9)

Get log entries

You now have a method on your model : logEntries which is a morphTo relationship., _(*10)

$logEntries = $model->logEntries();

foreach ($logEntries as $logEntry) {
    /**
     * LogEntry object :
     * action, logged_at, object_id, version, reason, data (as json), user_id
     */
}

Revert

You can revert your model to a previous state using the revert method like so :, _(*11)

$model = MyModel::find($id);

$model->revert(); // Revert to the first revision
$model->revert(5); // Revert to the 5th revision

Enjoy it ! Feel free to fork :) !, _(*12)