README

Leer en Espanol

Laravel library for recording changes (create, update, delete) in models.
Records JSON snapshots of changes, the responsible user, and the date of the change in a database table.

📦 Installation

Add the package to your project via Composer:

composer require carlosdev/model-change-logger

Make sure you have PHP 8.0+ and Laravel 10 - 13.

🔧 Configuration

Publish and run migrations:

php artisan migrate

Use the trait in the model you want to audit:

use CarlosDev\ModelChangeLogger\Traits\TracksChanges;

class JobOffer extends Model
{
    use TracksChanges;
}

(Optional) Audit only specific attributes: If you want to record only certain attributes, define the $auditFields property in your model:

protected array $auditFields = ['job_offer_status_id', 'title'];

🧪 Examples

Create

$post = Post::create([
        'title' => 'Hello World',
        'content' => 'First post',
]);

Recorded values:

{
    "event": "created",
    "old_value": null,
    "new_value": {
        "title": "Hello World",
        "content": "First post"
    }
}

Update

$post->update(['title' => 'New title']);

Recorded values:

{
    "event": "updated",
    "old_value": {
        "title": "Hello World"
    },
    "new_value": {
        "title": "New title"
    }
}

Delete

$post->delete();

Recorded values:

{
    "event": "deleted",
    "old_value": {
        "title": "New title",
        "content": "First post"
    },
    "new_value": null
}

🧠 What does it record?

• JSON payload with old/new values for changed attributes on update().
• JSON payload with all tracked attributes on create.
• Deletions (delete and forceDelete), saving a JSON snapshot of tracked attributes in old_value.
• Responsible user (Auth::id()).
• Affected model and ID.
• Date and time of the change.

📄 Structure of the model_changes table

✅ Compatibility

• PHP: >= 8.0
• Laravel: ^10.0 - ^13.0

📬 Contributions

Suggestions, improvements, and pull requests are welcome! 🚀

This package is designed for projects that require change traceability without depending on complex auditing packages.

📄 License

MIT © CarlosDev