yajra/laravel-auditable
Stars: 133
Forks: 24
Pull Requests: 19
Issues: 7
Watchers: 4
Last Updated: 2023-04-11 04:43:40
Basic Auditable package for Eloquent Model.
License: MIT License
Languages: PHP
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-auditablePublish config file
If you want to modify the withDefault option on auditable columns, you may publish the config file.
php artisan vendor:publish --tag=auditableUsage
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 testContributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.