README

This package provides ability to generate _logs table from your model.

Requirement

• PHP 8.1 - 8.4
• Laravel 9, 10, 11, 12

Getting Started

install

composer require jhonoryza/laravel-model-history

Usage

let's say you want to create table category_logs

we can achieve this with running this command:

php artisan model-history:generate categories

it will generate new migration for table category_logs and new model CategoryLog

then you can add to the log like this :

<?php

use Jhonoryza\LaravelModelHistory\Factory\History;
use App\Models\CategoryLog;

History::make(CategoryLog::class)
    ->model($category)                      // required
    ->changeBy(auth()->user())              // optional
    ->old($oldData)                         // optional
    ->new($newData)                         // optional
    ->operation(History::UPDATE)            // required
    ->log('Category updated successfully'); // required

to get all the logs

<?php

return History::make(CategoryLog::class)
    ->getLogs($category->id);

Detect From Model Event

you can make adding log automatically by detecting from model event

like created, updated, deleted, restored and force deleted

by adding trait ModelHistoryTrait to your model, then it will create log entry automatically

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Jhonoryza\LaravelModelHistory\Traits\ModelHistoryTrait;

class Category extends Model
{
    use ModelHistoryTrait;

    protected static function historyModel(): string
    {
        return CategoryLog::class;
    }
}

Laravel Eloquent Events Reference

Available events :

• retrieved
• creating / created
• updating / updated
• saving / saved
• deleting / deleted
• restoring / restored
• forceDeleted

Create & Update Operations

Delete & Soft Delete

Restore (SoftDeletes only)

Retrieval

Other Methods

React Component

there is prebuilt react component in this path resources/js/components/log-panel-history.tsx.

Usage

example use in controller

<?php

    public function show(Game $game): Response
    {
        return Inertia::render('builder/show', [
            'form' => GameForm::view($game),
            'logs' => History::make(GameLog::class)
                ->getLogs($game->id),
        ]);
    }

example use in edit.tsx

{
  logs && logs.length > 0 && <LogHistoryPanel logs={logs} />;
}

Security

If you've found a bug regarding security, please mail jardik.oryza@gmail.com instead of using the issue tracker.

License

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