Blameable behavior implementation for your Eloquent Model in Laravel
This package would help you to track the creator and updater of each database record. It would be done by filling the specified attributes with the current user ID automatically. By default, those attributes would be filled when you are saving the Eloquent Model object.
Install the package via Composer :
$ composer require richan-fongdasen/eloquent-blameable
Laravel version | Blameable version |
---|---|
5.1.x | 1.0.x |
5.2.x - 5.4.x | 1.1.x - 1.2.x |
5.5.x - 5.8.x | 1.3.x |
6.x | 1.4.x |
7.x | 1.5.x |
8.x | 1.6.x |
9.x | 1.8.x |
10.x | 1.9.x |
10.x | 1.10.x |
If you are using Laravel version 5.5+ then you can skip registering the service provider in your Laravel application.
Add the package service provider in your config/app.php
'providers' => [
// ...
RichanFongdasen\EloquentBlameable\ServiceProvider::class,
];
Publish configuration file using php artisan
command
$ php artisan vendor:publish --provider="RichanFongdasen\EloquentBlameable\ServiceProvider"
The command above would copy a new configuration file to /config/blameable.php
return [
/*
|--------------------------------------------------------------------------
| Authentication Guard
|--------------------------------------------------------------------------
|
| Please specify your default authentication guard to be used by blameable
| service. You can leave this to null if you're using the default Laravel
| authentication guard.
|
| You can also override this value in model classes to use a different
| authentication guard for your specific models.
| IE: Some of your models can only be created / updated by specific users
| who logged in from a specific authentication guard.
|
*/
'guard' => null,
/*
|--------------------------------------------------------------------------
| User Model Definition
|--------------------------------------------------------------------------
|
| Please specify a user model that should be used to setup `creator`
| and `updater` relationship.
|
*/
'user' => \App\User::class,
/*
|--------------------------------------------------------------------------
| The `createdBy` attribute
|--------------------------------------------------------------------------
|
| Please define an attribute to use when recording the creator
| identifier.
|
*/
'createdBy' => 'created_by',
/*
|--------------------------------------------------------------------------
| The `updatedBy` attribute
|--------------------------------------------------------------------------
|
| Please define an attribute to use when recording the updater
| identifier.
|
*/
'updatedBy' => 'updated_by',
/*
|--------------------------------------------------------------------------
| The `deletedBy` attribute
|--------------------------------------------------------------------------
|
| Please define an attribute to use when recording the user
| identifier who deleted the record. This feature would only work
| if you are using SoftDeletes in your model.
|
*/
'deletedBy' => 'deleted_by',
];
Schema::create('some_tables', function (Blueprint $table) {
// ...
$table->integer('created_by')->nullable();
$table->integer('updated_by')->nullable();
$table->integer('deleted_by')->nullable();
// ...
/**
* You can also create foreign key constrains
* for the blameable attributes.
*/
$table->foreign('created_by')
->references('id')->on('users')
->onDelete('cascade');
$table->foreign('updated_by')
->references('id')->on('users')
->onDelete('cascade');
});
use Illuminate\Database\Eloquent\Model;
use RichanFongdasen\EloquentBlameable\BlameableTrait;
class Post extends Model
{
use BlameableTrait;
// ...
}
/**
* You can override the default configuration
* by defining this static property in your Model
*/
protected static $blameable = [
'guard' => 'customGuard',
'user' => \App\User::class,
'createdBy' => 'user_id',
'updatedBy' => null
];
/**
* You can override the default configuration
* by defining this method in your Model
*/
public function blameable()
{
return [
'guard' => 'customGuard',
'user' => \App\User::class,
'createdBy' => 'user_id',
'updatedBy' => null
];
}
// Get all posts which have created by the given user id
Post::createdBy($userId)->get();
// Get all posts which have updated by the given user object
$user = User::findOrFail(1);
Post::updatedBy($user)->get();
// Get the creator user object
Post::findOrFail($postId)->creator;
// Get the updater user object
Post::findOrFail($postId)->updater;
The MIT License (MIT). Please see License File for more information.