Download the PHP package patoui/model-history without Composer

📝 Laravel Model History Package

A Laravel package that allows you to track changes to your Eloquent models (history) in an opt-in fashion. The package provides extensibility, so you can store changes in your preferred storage system.

✨ Features

• Opt-in tracking: Models choose to track changes by using a trait
• Tracks creation and updates: Captures both model creation and modification events
• Extensibility: Use the default Eloquent implementation or create your own
• Configurable: Configuration available for additional control

📦 Installation

You can install the package via composer:

Optionally, you can publish the config file with:

Optionally, you can publish and run the migrations with:

You can publish both config and migrations at once with:

⚙️ Configuration

After publishing the config file, you can customize the package behavior by editing config/model-history.php.

🎯 Customizing the model history

You can customize which model is used for storing changes:

🚫 Customizing Excluded Properties

You can customize which properties are excluded from the model history by modifying the exclude_properties array in your published config file. For example, if you want to also exclude password fields and any _token fields:

🔧 Model configuration

You may add an additional property to the model to override the default configuration of excluded properties

🚀 Usage

📚 Basic Usage

To start tracking changes for a model, simply add the TrackModelHistory trait and the TrackModelHistoryContract interface:

Now any changes to this model will be automatically tracked:

🗄️ Using non-Eloquent storage

This package provides a ModelHistoryRepositoryContract so you may implement your own repository. Once implemented you can simply override the registered singleton in your app service provider

🏠 Using ClickHouse

Here's an example using ClickHouse with the Laravel ClickHouse package.

First, install the Laravel ClickHouse package:

Complete the setup from the package.

Create a migration for the changes table:

Create a ClickHouse model for the model history:

Now publish the config

Now update the model with your own

🧪 Testing

📋 Changelog

Please see CHANGELOG for more information on what has changed recently.

👥 Credits

• Patrique Ouimet
• All Contributors

📄 License

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