PHPackages                             local-dynamics/laravel-revisionable - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. local-dynamics/laravel-revisionable

ActiveLibrary[Database & ORM](/categories/database)

local-dynamics/laravel-revisionable
===================================

Keep a revision history for your models without thinking, created as a package for use with Laravel

v13.0.0(1mo ago)13.4kMITPHPPHP >=8.4CI failing

Since Aug 30Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/local-dynamics/laravel-revisionable)[ Packagist](https://packagist.org/packages/local-dynamics/laravel-revisionable)[ Docs](http://github.com/local-dynamics/laravel-revisionable)[ RSS](/packages/local-dynamics-laravel-revisionable/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (8)Versions (23)Used By (0)

Revisons for Laravel Eloquent
=============================

[](#revisons-for-laravel-eloquent)

[![Laravel 5.8](https://camo.githubusercontent.com/587f825d686f4cf73655f19031afb8dfa137c3dd9cd71d1b42edeb4af56ab366/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d352e782d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://laravel.com/)[![Latest Version](https://camo.githubusercontent.com/2a1629c070c0ffe3f9607b7676483977bce7716df9fdd190453312a4051908bf/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6c6f63616c2d64796e616d6963732f6c61726176656c2d7265766973696f6e61626c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/local-dynamics/laravel-revisionable)[![License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://tldrlegal.com/license/mit-license)

Wouldn't it be nice to have a revision history for any model in your project, without having to do any work for it. By simply adding the `IsRevisionable` Trait to your model, you can instantly have just that, and be able to display a history similar to this:

- Chris changed title from 'Something' to 'Something else'
- Chris changed category from 'News' to 'Breaking news'
- Matt changed category from 'Breaking news' to 'News'

So not only can you see a history of what happened, but who did what, so there's accountability.

Revisionable is a laravel package that allows you to keep a revision history for your models without thinking. For some background and info, [see this article](http://www.chrisduell.com/blog/development/keeping-revisions-of-your-laravel-model-data/)

Installation
------------

[](#installation)

Revisionable is installable via [composer](https://getcomposer.org/doc/00-intro.md), the details are on [packagist, here.](https://packagist.org/packages/LocalDynamics/revisionable)

Add the following to the `require` section of your projects composer.json file:

```
"local-dynamics/laravel-revisionable": "1.*",
```

Run composer update to download the package

```
php composer.phar update

```

Open config/app.php and register the required service provider

```
'providers' => [
    LocalDynamics\Revisionable\ServiceProvider::class,
]

```

Publish the configuration and migrations

```
php artisan vendor:publish --provider="LocalDynamics\Revisionable\ServiceProvider"

```

Finally, you'll also need to run migration on the package

```
php artisan migrate

```

Docs
----

[](#docs)

- [Implementation](#intro)
- [More control](#control)
- [Format output](#formatoutput)
- [Load revision history](#loadhistory)
- [Display history](#display)

Implementation
--------------

[](#implementation)

For any model that you want to keep a revision history for, include the `LocalDynamics\Revisionable` namespace and use the `IsRevisionable` in your model, e.g.,

```
namespace App;

use \LocalDynamics\Revisionable\Concerns\IsRevisionable;

class Article extends \Illuminate\Database\Eloquent\Model {

    use IsRevisionable;

}
```

### Implementation notes

[](#implementation-notes)

If needed, you can disable the revisioning by setting `$revisionEnabled` to false in your Model. This can be handy if you want to temporarily disable revisioning, or if you want to create your own base Model that extends Revisionable, which all of your models extend, but you want to turn Revisionable off for certain models.

```
namespace App;

use \LocalDynamics\Revisionable\Concerns\IsRevisionable;

class Article extends \Illuminate\Database\Eloquent\Model {

    use IsRevisionable;

    protected $revisionEnabled = false;

}
```

You can also disable revisioning after X many revisions have been made by setting `$historyLimit` to the number of revisions you want to keep before stopping revisions.

```
namespace App;

use \LocalDynamics\Revisionable\Concerns\IsRevisionable;

class Article extends \Illuminate\Database\Eloquent\Model {

    use IsRevisionable;

    protected $revisionEnabled = true;
    protected $historyLimit = 500; //Stop tracking revisions after 500 changes have been made.

}
```

In order to maintain a limit on history, but instead of stopping tracking revisions if you want to remove old revisions, you can accommodate that feature by setting `$revisionCleanup`.

```
namespace App;

use \LocalDynamics\Revisionable\Concerns\IsRevisionable;

class Article extends \Illuminate\Database\Eloquent\Model {

    use IsRevisionable;

    protected $revisionEnabled = true;
    protected $revisionCleanup = true; //Remove old revisions (works only when used with $historyLimit)
    protected $historyLimit = 500; //Maintain a maximum of 500 changes at any point of time, while cleaning up old revisions.

}
```

### Storing Soft Deletes

[](#storing-soft-deletes)

By default, if your model supports soft deletes, Revisionable will store this and any restores as updates on the model.

You can choose to ignore deletes and restores by adding `deleted_at` to your `$dontKeepRevisionOf` array.

To better format the output for `deleted_at` entries, you can use the `isEmpty` formatter (see [Format output](#format-output) for an example of this.)

### Storing Creations

[](#storing-creations)

By default the creation of a new model is not stored as a revision. Only subsequent changes to a model is stored.

If you want to store the creation as a revision you can override this behavior by setting `revisionCreationsEnabled` to `true` by adding the following to your model:

```
protected $revisionCreationsEnabled = true;
```

More Control
------------

[](#more-control)

No doubt, there'll be cases where you don't want to store a revision history only for certain fields of the model, this is supported in two different ways. In your model you can either specifiy which fields you explicitly want to track and all other fields are ignored:

```
protected $keepRevisionOf = ['title'];
```

Or, you can specify which fields you explicitly don't want to track.
All other fields will be tracked.

```
protected $dontKeepRevisionOf = ['category_id'];
```

> The `$keepRevisionOf` setting takes precedence over `$dontKeepRevisionOf`

### Events

[](#events)

Every time a model revision is created an event is fired.
You can listen for `revisionable.created`, `revisionable.saved` or `revisionable.deleted`.

```
// app/Providers/EventServiceProvider.php

public function boot()
{
    parent::boot();

    Event::listen('revisionable.*', function($model, $revisions) {
        // Do something with the revisions or the changed model.
        dd($model, $revisions);
    });
}
```

Format output
-------------

[](#format-output)

> You can continue (and are encouraged to) use `Eloquent accessors` in your model to set the output of your values, see the [Laravel Documentation for more information on accessors](https://laravel.com/docs/eloquent-mutators#accessors-and-mutators)The below documentation is therefor deprecated

In cases where you want to have control over the format of the output of the values, for example a boolean field, you can set them in the `$revisionFormattedFields` array in your model. e.g.,

```
protected $revisionFormattedFields = [
    'title'      => 'string:%s',
    'public'     => 'boolean:No|Yes',
    'modified'   => 'datetime:m/d/Y g:i A',
    'deleted_at' => 'isEmpty:Active|Deleted'
];
```

You can also override the field name output using the `$revisionFormattedFieldNames` array in your model, e.g.,

```
protected $revisionFormattedFieldNames = [
    'title'      => 'Title',
    'small_name' => 'Nickname',
    'deleted_at' => 'Deleted At'
];
```

This comes into play when you output the revision field name using `$revision->fieldName()`

### String

[](#string)

To format a string, simply prefix the value with `string:` and be sure to include `%s` (this is where the actual value will appear in the formatted response), e.g.,

```
string:%s

```

### Boolean

[](#boolean)

Booleans by default will display as a 0 or a 1, which is pretty bland and won't mean much to the end user, so this formatter can be used to output something a bit nicer. Prefix the value with `boolean:` and then add your false and true options separated by a pipe, e.g.,

```
boolean:No|Yes

```

### DateTime

[](#datetime)

DateTime by default will display as Y-m-d H:i:s. Prefix the value with `datetime:` and then add your datetime format, e.g.,

```
datetime:m/d/Y g:i A

```

### Is Empty

[](#is-empty)

This piggy backs off boolean, but instead of testing for a true or false value, it checks if the value is either null or an empty string.

```
isEmpty:No|Yes

```

This can also accept `%s` if you'd like to output the value, something like the following will display 'Nothing' if the value is empty, or the actual value if something exists:

```
isEmpty:Nothing|%s

```

Load revision history
---------------------

[](#load-revision-history)

To load the revision history for a given model, simply call the `revisionHistory` method on that model, e.g.,

```
$article = Article::find($id);
$history = $article->revisionHistory;
```

Displaying history
------------------

[](#displaying-history)

For the most part, the revision history will hold enough information to directly output a change history, however in the cases where a foreign key is updated we need to be able to do some mapping and display something nicer than `plan_id changed from 3 to 1`.
To help with this, there's a few helper methods to display more insightful information, so you can display something like `Chris changed plan from bronze to gold`.
The above would be the result from this:

```
@foreach($account->revisionHistory as $history )
    {{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}
@endforeach
```

If you have enabled revisions of creations as well you can display it like this:

```
@foreach($resource->revisionHistory as $history)
  @if($history->key == 'created_at' && !$history->old_value)
    {{ $history->userResponsible()->first_name }} created this resource at {{ $history->newValue() }}
  @else
    {{ $history->userResponsible()->first_name }} changed {{ $history->fieldName() }} from {{ $history->oldValue() }} to {{ $history->newValue() }}
  @endif
@endforeach
```

### userResponsible()

[](#userresponsible)

Returns the User that was responsible for making the revision. A user model is returned, or null if there was no user recorded.
The user model that is loaded depends on what you have set in your `config/auth.php` file for the `model` variable.

### fieldName()

[](#fieldname)

Returns the name of the field that was updated, if the field that was updated was a foreign key (at this stage, it simply looks to see if the field has the suffix of `_id`) then the text before `_id` is returned. e.g., if the field was `plan_id`, then `plan` would be returned.

> Remember from above, that you can override the output of a field name with the `$revisionFormattedFieldNames` array in your model.

### identifiableName()

[](#identifiablename)

This is used when the value (old or new) is the id of a foreign key relationship.
By default, it simply returns the ID of the model that was updated. It is up to you to override this method in your own models to return something meaningful. e.g.,

```
use LocalDynamics\Revisionable\Concerns\IsRevisionable;

class Article
{
    use IsRevisionable; // title;
    }

}
```

### oldValue() and newValue()

[](#oldvalue-and-newvalue)

Get the value of the model before or after the update. If it was a foreign key, identifiableName() is called.

### Unknown or invalid foreign keys as revisions

[](#unknown-or-invalid-foreign-keys-as-revisions)

In cases where the old or new version of a value is a foreign key that no longer exists, or indeed was null, there are two variables that you can set in your model to control the output in these situations:

```
protected $revisionNullString    = 'nothing';
protected $revisionUnknownString = 'unknown';
```

### disableRevisionField()

[](#disablerevisionfield)

Sometimes temporarily disabling a revisionable field can come in handy, if you want to be able to save an update however don't need to keep a record of the changes.

```
$object->disableRevisionField('title'); // Disables title
```

or:

```
$object->disableRevisionField(['title', 'content']); // Disables title and content
```

Credits
-------

[](#credits)

- forked from [VentureCraft/revisionable Package](https://github.com/VentureCraft/revisionable)

###  Health Score

55

—

FairBetter than 98% of packages

Maintenance89

Actively maintained with recent releases

Popularity19

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity85

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~114 days

Recently: every ~177 days

Total

22

Last Release

54d ago

Major Versions

v8.1.1 → v9.0.02022-02-10

v9.2.0 → v10.0.02023-02-14

v10.0.0 → v11.0.02023-03-27

v11.0.4 → v12.0.02025-03-07

v12.0.0 → v13.0.02026-03-19

PHP version history (6 changes)v1.0PHP >=7.2

v7.0.0PHP >=7.2.5

v9.0.0PHP >=8.0

v9.1.0PHP >=8.1

v11.0.1PHP >=8.2

v12.0.0PHP >=8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/cb1a5b94516408900ac701b7333a446094a2787e0feee1f489f546af1c5a760f?d=identicon)[ThomasEnssner](/maintainers/ThomasEnssner)

---

Top Contributors

[![ThomasEnssner](https://avatars.githubusercontent.com/u/1965267?v=4)](https://github.com/ThomasEnssner "ThomasEnssner (33 commits)")

---

Tags

laravelrevision-historylaravelmodelAuditrevisionhistory

###  Code Quality

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/local-dynamics-laravel-revisionable/health.svg)

```
[![Health](https://phpackages.com/badges/local-dynamics-laravel-revisionable/health.svg)](https://phpackages.com/packages/local-dynamics-laravel-revisionable)
```

###  Alternatives

[venturecraft/revisionable

Keep a revision history for your models without thinking, created as a package for use with Laravel

2.6k6.6M51](/packages/venturecraft-revisionable)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)