ameoba32/laravel-auditing

Record the change log from models in Laravel 5.*

It is always important to have change history records in the system. The Auditing does just that simple and practical way, you simply extends it in the model you would like to register the change log.

Auditing is based on the package revisionable

Installation

Auditing is installable via composer, the details are here.

Run the following command to get the latest version package

composer require owen-it/laravel-auditing

Open config/app.php and register the required service provider.

'providers' => [
    // ...
    OwenIt\Auditing\AuditingServiceProvider::class,
],

Note: This provider is important for the publication of configuration files.

Use the following command to publish settings:

php artisan vendor:publish --provider="OwenIt\Auditing\AuditingServiceProvider"

Now you need execute the mitration to create the table logs in your database, this table is used for save logs of altering.

php artisan migrate

Docs

• Implementation
• Configuration
• Getting the Logs
• Customizing log message
• Examples
• Contributing
• Having problems?
• license

Implementation

Implementation using Trait

To register the change log, use the trait OwnerIt\Auditing\AuditingTrait in the model you want to audit

// app/Team.php
namespace App;

use Illuminate\Database\Eloquent\Model;
use OwenIt\Auditing\AuditingTrait;

class Team extends Model 
{
    use AuditingTrait;
    //...
}

Note: Traits require PHP >= 5.4

Base implementation Legacy Class

To register the chage log with Legacy class, extend the class OwnerIt\Auditing\Auditing in the model you want to audit. Example:

// app/Team.php
namespace App;

use OwenIt\Auditing\Auditing;

class Team extends Auditing 
{
    //...    
}

Configuration

The Auditing behavior settings are carried out with the declaration of attributes in the model. See the examples below:

• Turn off logging after a number "X": $historyLimit = 500
• Disable / enable logging (Audit): $auditEnabled = false
• Turn off logging for specific fields: $dontKeepLogOf = ['field1', 'field2']

// app/Team.php
namespace App;

use Illuminate\Database\Eloquent\Model;

class Team extends Model 
{
    use OwenIt\Auditing\AuditingTrait;
    // Disables the log record in this model.
    protected $auditEnabled  = false;
    // Disables the log record after 500 records.
    protected $historyLimit = 500; 
    // Fields you do NOT want to register.
    protected $dontKeepLogOf = ['created_at', 'updated_at'];
    // Tell what actions you want to audit.
    protected $auditableTypes = ['created', 'saved', 'deleted'];
}

Getting the Logs

// app/Http/Controller/MyAppController.php
namespace App\Http\Controllers;

use App\Team;

class MyAppController extends BaseController 
{
    public function index()
    {
        $team = Team::find(1); // Get team
        $team->logs; // Get all logs
        $team->logs->first(); // Get first log
        $team->logs->last();  // Get last log
        $team->logs->find(2); // Selects log
    }
    //...
}

Getting logs with user responsible for the change.

use OwenIt\Auditing\Log;

$logs = Log::with(['user'])->get();

or

use App\Team;

$logs = Team::logs->with(['user'])->get();

Note: Remember to properly define the user model in the file config/auth.php

...
'model' => App\User::class,
... 

Customizing log message

You it can set custom messages for presentation of logs. These messages can be set for both the model as for specific fields.The dynamic part of the message can be done by targeted fields per dot segmented as{objeto.value.value} or {object.value|Default value} or {object.value||callbackMethod}.

Note: This implementation is optional, you can make these customizations where desired.

Set messages to the model

// app/Team.php
namespace App;

use OwenIt\Auditing\Auditing;

class Team extends Auditing 
{
    //...
    public static $logCustomMessage = '{user.name|Anonymous} {type} a team {elapsed_time}'; // with default value
    public static $logCustomFields = [
        'name'  => 'The name was defined as {new.name||getNewName}', // with callback method
        'owner' => [
            'updated' => '{new.owner} owns the team',
            'created' => '{new.owner|No one} was defined as owner'
        ],
    ];
    
    public function getNewName($log)
    {
        return $log->new['name'];
    }
    //...
}

Getting change logs

// app/Http/Controllers/MyAppController.php 
//...
public function auditing()
{
    $logs = Team::find(1)->logs; // Get logs of team
    return view('auditing', compact('logs'));
}
//...
    

Featuring log records:

    // resources/views/my-app/auditing.blade.php
    ...
    <ol>
        @forelse ($logs as $log)
            <li>
                {{ $log->customMessage }}
                <ul>
                    @forelse ($log->customFields as $custom)
                        <li>{{ $custom }}</li>
                    @empty
                        <li>No details</li>
                    @endforelse
                </ul>
            </li>
        @empty
            <p>No logs</p>
        @endforelse
    </ol>
    ...
    

Result:

1. Antério Vieira created a team 1 day ago
   • The name was defined as gestao
   • No one was defined as owner
2. Rafael França deleted a team 2 day ago
   • No details
3. ...

Examples

Spark Auditing

For convenience we decided to use the spark for this example, the demonstration of auditing is simple and self explanatory. Click here and see for yourself.

Dreams

Dreams is a developed api to serve as an example or direction for developers using laravel-auditing. You can access the application here. The back-end (api) was developed in laravel 5.1 and the front-end (app) in angularjs, the detail are these:

• Link for application
• Source code api-dreams
• Source code app-dreams

Contributing

Contributions are welcomed; to keep things organized, all bugs and requests should be opened on github issues tab for the main project in the owen-it/laravel-auditing/issues.

All pull requests should be made to the branch Develop, so they can be tested before being merged into the master branch.

Having problems?

If you are having problems with the use of this package, there is likely someone has faced the same problem. You can find common answers to their problems:

• Github Issues

License

The laravel-audit package is open source software licensed under the license MIT