https://github.com/turahe/laravel-userstamps
https://github.com/turahe/laravel-userstamps
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/turahe/laravel-userstamps
- Owner: turahe
- License: mit
- Created: 2024-09-10T07:49:02.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-03-02T15:48:38.000Z (3 months ago)
- Last Synced: 2025-03-25T09:51:13.131Z (3 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Package to maintain the users who created, updated and deleted eloquent models
Provides an Eloquent trait to automatically maintain the created_by, updated_by, and deleted_by (when using softDeletes)
on your models by the currently logged in user.
## Installation and usage
This package requires PHP 8 and Laravel 5.6 or higher. Install the package by running the following command in your console;
``` bash
composer require turahe/laravel-userstamps
```
You can publish the config file with:
``` bash
php artisan vendor:publish --provider="Turahe\UserStamps\UserStampsServiceProvider" --tag="config"
```
This is the contents of the published config file:
``` php
return [
/*
* Define the table which is used in the database to retrieve the users
*/
'users_table' => 'users',
/*
* Define the table column type which is used in the table schema for
* the id of the user
*
* Options: increments, bigIncrements, uuid
* Default: bigIncrements
*/
'users_table_column_type' => 'bigIncrements',
/*
* Define the name of the column which is used in the foreign key reference
* to the id of the user
*/
'users_table_column_id_name' => 'id',
/*
* Define the mmodel which is used for the relationships on your models
*/
'users_model' => \App\Models\User::class,
/*
* Define the column which is used in the database to save the user's id
* which created the model.
*/
'created_by_column' => 'created_by',
/*
* Define the column which is used in the database to save the user's id
* which updated the model.
*/
'updated_by_column' => 'updated_by',
/*
* Define the column which is used in the database to save the user's id
* which deleted the model.
*/
'deleted_by_column' => 'deleted_by',
];
```
Add the macro to your migration of your model
``` php
public function up()
{
Schema::create('table_name', function (Blueprint $table) {
...
$table->userstamps();
$table->softUserstamps();
});
}
```
Add the Trait to your model
``` php
use Turahe\UserStamps\Concerns\HasUserStamps;
class Example extends Model {
use HasUserStamps;
}
```
There will be methods available to retrieve the user object which performs the action for creating, updating or deleting
``` php
$model->author; // the user who created the model
$model->editor; // the user who last updated the model
$model->destroyer; // the user who deleted the model
```