A simple Laravel user auditing package for Eloquent Model.

yajra/laravel-auditable image

yajra/laravel-auditable stats

Downloads
108.6K
Stars
134
Open Issues
0
Forks
24

View on GitHub →

Yajra Laravel-auditable Readme


Laravel Auditable

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.

Install via Composer

composer require yajra/laravel-auditable

Publish config file

If you want to modify the withDefault option on auditable columns, you may publish the config file.

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.

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

Then use AuditableTrait on your model.

namespace App;
 
use Yajra\Auditable\AuditableTrait;
 
class User extends Model
{
use AuditableTrait;
}

Soft Deletes

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

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.

namespace App;
 
use Yajra\Auditable\AuditableWithDeletesTrait;
 
class User extends Model
{
use AuditableWithDeletesTrait, SoftDeletes;
}

Dropping columns

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

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.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker.

Credits

License

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

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.


Yajra Laravel Auditable Related Articles

Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate logo

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate

Build your SaaS application in hours. Out-of-the-box multi-tenancy and seamless Stripe integration. Supports subscriptions and one-time purchases, allowing you to focus on building and creating without repetitive setup tasks.

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises