yajra/laravel-auditable

A simple Laravel user auditing package for Eloquent Model.

Laravel Auditable

![Software License][ico-license], _(*1)

![Total Downloads][ico-downloads], _(*2)

Laravel Auditable is a simple Laravel auditing package for your Eloquent Model. This package automatically inserts/updates an audit log on your table on who created and last updated the record., _(*3)

Laravel Version Compatibility

Install via Composer

composer require yajra/laravel-auditable:^12

Publish config file

If you want to modify the withDefault option on auditable columns, you may publish the config file., _(*4)

php artisan vendor:publish --tag=auditable

Usage

Update your model's migration and add created_by and updated_by field using the auditable() blueprint macro., _(*5)

Schema::create('users', function (Blueprint $table) {
    $table->increments('id');
    $table->string('name', 100);
    $table->auditable();
    $table->timestamps();
});

Then use AuditableTrait on your model., _(*6)

``` php namespace App;, <sub>(*7)</sub>

use Yajra\Auditable\AuditableTrait;, <sub>(*8)</sub>

class User extends Model { use AuditableTrait; }, <sub>(*9)</sub>

## Soft Deletes

If you wish to use Laravel's soft deletes, use the `auditableWithDeletes()` method on your migration instead:

```php
Schema::create('users', function (Blueprint $table) {
    $table->increments('id');
    $table->string('name', 100);
    $table->auditableWithDeletes();
    $table->timestamps();
    $table->softDeletes()
});

Afterwards, you need to use AuditableWithDeletesTrait on your model., <sub>(*10)</sub>

``` php namespace App;, <sub>(*11)</sub>

use Yajra\Auditable\AuditableWithDeletesTrait;, <sub>(*12)</sub>

class User extends Model { use AuditableWithDeletesTrait, SoftDeletes; }, <sub>(*13)</sub>

## Dropping columns

You can drop auditable columns using `dropAuditable()` method, or `dropAuditableWithDeletes()` if using soft deletes.

```php
Schema::create('users', function (Blueprint $table) {
    $table->dropAuditable();
});

And you're done! The package will now automatically add a basic audit log for your model to track who inserted and last updated your records., <sub>(*14)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*15)</sub>

Testing

bash composer test, <sub>(*16)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*17)</sub>

Security

If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker., <sub>(*18)</sub>

Credits

• Arjay Angeles
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*19)</sub>