README

Auditable

This package is developed based on VentureCraft/Revisionable

Wouldn't it be nice to have a audit history for any model in your project, without having to do any work for it. By simply extending auditable from your model, you can instantly have just that, and be able to display a history similar to this:

Feroj changed title from 'Something' to 'Something else'
Sajid changed category from 'News' to 'Breaking news'
Faheem changed category from 'Breaking news' to 'News'
Samiul viewed this resource on December 21, 2015 03:45PM.

So not only can you see a history of what happened, but who did what, so there's accountability.

Auditable is a laravel package that allows you to keep a audit history for your models without thinking. For some background and info, see this article

Working with 3rd party Auth / Eloquent extensions

Auditable has support for Auth powered by

Auditable can also now be used as a trait, so your models can continue to extend Eloquent, or any other class that extends Eloquent (like Ardent).

Installation

Auditable is installable via composer, the details are on packagist, here.

Add the following to the require section of your projects composer.json file:

"samveloper/auditable": "1.*",

Run composer update to download the package

composer update

Finally, you'll also need to run migration on the package

php artisan migrate --package=samveloper/auditable

If you're going to be migrating up and down completely a lot (using migrate:refresh), one thing you can do instead is to copy the migration file from the package to your app/database folder, and change the classname from CreateAuditsTable to something like CreateAuditTable (without the 's', otherwise you'll get an error saying there's a duplicate class)

cp vendor/samveloper/auditable/src/migrations/2016_01_18_060817_create_audits_table.php database/migrations/

Implementation

The new, trait based implementation

For any model that you want to keep a audit history for, include the auditable namespace and use the AuditableTrait in your model, e.g., If you are using another bootable trait the be sure to override the boot method in your model;

namespace MyApp\Models;

class Article extends Eloquent {
    use \Samveloper\Auditable\AuditableTrait;

    public static function boot()
    {
        parent::boot();
    }
}

Being a trait, auditable can now be used with the standard Eloquent model, or any class that extends Eloquent, like Ardent for example.

Traits require PHP >= 5.4

Legacy class based implementation

The new trait based approach is backwards compatible with existing installations of Auditable. You can still use the below installation instructions, which essentially is extending a wrapper for the trait.

For any model that you want to keep a audit history for, include the auditable namespace and extend auditable instead of eloquent, e.g.,

use Samveloper\Auditable\Auditable;

namespace MyApp\Models;

class Article extends Auditable { }

Note that it also works with namespaced models.

Implementation notes

If needed, you can disable the auditing by setting $auditEnabled to false in your model. This can be handy if you want to temporarily disable auditing, or if you want to create your own base model that extends auditable, which all of your models extend, but you want to turn auditable off for certain models.

namespace MyApp\Models;

class Article extends Eloquent {
    use Samveloper\Auditable\AuditableTrait;

    protected $auditEnabled = false;
}

You can also disable auditing after X many audits have been made by setting $historyLimit to the number of audits you want to keep before stopping audits.

namespace MyApp\Models;

class Article extends Eloquent {
    use Samveloper\Auditable\AuditableTrait;

    protected $auditEnabled = true;
    protected $historyLimit = 500; //Stop tracking audits after 500 changes have been made.
}

In order to maintain a limit on history, but instead of stopping tracking audits if you want to remove old audits, you can accommodate that feature by setting $auditCleanup.

namespace MyApp\Models;

class Article extends Eloquent {
    use Samveloper\Auditable\AuditableTrait;

    protected $auditEnabled = true;
    protected $auditCleanup = true; //Remove old audits (works only when used with $historyLimit)
    protected $historyLimit = 500; //Maintain a maximum of 500 changes at any point of time, while cleaning up old audits.
}

Storing soft deletes

By default, if your model supports soft deletes, auditable will store this and any restores as updates on the model.

You can choose to ignore deletes and restores by adding deleted_at to your $dontKeepAuditOf array.

To better format the output for deleted_at entries, you can use the isEmpty formatter (see Format output for an example of this.)

Storing creations

By default the creation of a new model is not stored as a audit. Only subsequent changes to a model is stored.

If you want to store the creation as a audit you can override this behavior by setting auditCreationsEnabled to true by adding the following to your model:

protected $auditCreationsEnabled = true;

More control

No doubt, there'll be cases where you don't want to store a audit history only for certain fields of the model, this is supported in two different ways. In your model you can either specify which fields you explicitly want to track and all other fields are ignored:

protected $keepAuditOf = array(
    'title'
);

Or, you can specify which fields you explicitly don't want to track. All other fields will be tracked.

protected $dontKeepAuditOf = array(
    'category_id'
);

The $keepAuditOf setting takes precendence over $dontKeepAuditOf

Format output

You can continue (and are encouraged to) use eloquent accessors in your model to set the output of your values, see the laravel docs for more information on accessors The below documentation is therefor deprecated

In cases where you want to have control over the format of the output of the values, for example a boolean field, you can set them in the $auditFormattedFields array in your model. e.g.,

protected $auditFormattedFields = array(
    'title'  => 'string:<strong>%s</strong>',
    'public' => 'boolean:No|Yes',
    'modified' => 'datetime:m/d/Y g:i A',
    'deleted_at' => 'isEmpty:Active|Deleted'
);

You can also override the field name output using the $auditFormattedFieldNames array in your model, e.g.,

protected $auditFormattedFieldNames = array(
    'title' => 'Title',
    'small_name' => 'Nickname',
    'deleted_at' => 'Deleted At'
);

This comes into play when you output the audit field name using $audit->fieldName()

String

To format a string, simply prefix the value with string: and be sure to include %s (this is where the actual value will appear in the formatted response), e.g.,

string:<strong>%s</strong>

Boolean

Booleans by default will display as a 0 or a 1, which is pretty bland and won't mean much to the end user, so this formatter can be used to output something a bit nicer. Prefix the value with boolean: and then add your false and true options separated by a pipe, e.g.,

boolean:No|Yes

DateTime

DateTime by default will display as Y-m-d H:i:s. Prefix the value with datetime: and then add your datetime format, e.g.,

datetime:m/d/Y g:i A

Is Empty

This piggy backs off boolean, but instead of testing for a true or false value, it checks if the value is either null or an empty string.

isEmpty:No|Yes

This can also accept %s if you'd like to output the value, something like the following will display 'Nothing' if the value is empty, or the actual value if something exists:

isEmpty:Nothing|%s

Load audit history

To load the audit history for a given model, simply call the auditHistory method on that model, e.g.,

$article = Article::find($id);
$history = $article->auditHistory;

Displaying history

For the most part, the audit history will hold enough information to directly output a change history, however in the cases where a foreign key is updated we need to be able to do some mapping and display something nicer than plan_id changed from 3 to 1.

To help with this, there's a few helper methods to display more insightful information, so you can display something like Chris changed plan from bronze to gold.

The above would be the result from this:

@foreach($account->auditHistory as $history )
    <li>{{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}</li>
@endforeach

If you have enabled audits of creations as well you can display it like this:

@foreach($resource->auditHistory as $history)
  @if($history->key == 'created_at' && !$history->old_value)
    <li>{{ $history->userResponsible()->first_name }} created this resource at {{ $history->newValue() }}</li>
  @else
    <li>{{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}</li>
  @endif
@endforeach

userResponsible()

Returns the User that was responsible for making the audit. A user model is returned, or null if there was no user recorded.

The user model that is loaded depends on what you have set in your config/auth.php file for the model variable.

fieldName()

Returns the name of the field that was updated, if the field that was updated was a foreign key (at this stage, it simply looks to see if the field has the suffix of _id) then the text before _id is returned. e.g., if the field was plan_id, then plan would be returned.

Remember from above, that you can override the output of a field name with the $auditFormattedFieldNames array in your model.

identifiableName()

This is used when the value (old or new) is the id of a foreign key relationship.

By default, it simply returns the ID of the model that was updated. It is up to you to override this method in your own models to return something meaningful. e.g.,

use Samveloper\Auditable\Auditable;

class Article extends Auditable
{
    public function identifiableName()
    {
        return $this->title;
    }
}

oldValue() and newValue()

Get the value of the model before or after the update. If it was a foreign key, identifiableName() is called.

Unknown or invalid foreign keys as audits

In cases where the old or new version of a value is a foreign key that no longer exists, or indeed was null, there are two variables that you can set in your model to control the output in these situations:

protected $auditNullString = 'nothing';
protected $auditUnknownString = 'unknown';

disableAuditField()

Sometimes temporarily disabling a auditable field can come in handy, if you want to be able to save an update however don't need to keep a record of the changes.

$object->disableAuditField('title'); // Disables title

or:

$object->disableAuditField(array('title', 'content')); // Disables title and content

Change log

Please see CHANGELOG for more information what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

samveloper / auditable

Maintainers

Details