Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/VentureCraft/revisionable

Easily create a revision history for any laravel model
https://github.com/VentureCraft/revisionable

Last synced: 3 months ago
JSON representation

Easily create a revision history for any laravel model

Lists

README 

        
Revisionable for Laravel



[![Latest Version](https://img.shields.io/github/release/venturecraft/revisionable.svg?style=flat-square)](https://packagist.org/packages/venturecraft/revisionable)

[![Downloads](https://img.shields.io/packagist/dt/venturecraft/revisionable.svg?style=flat-square)](https://packagist.org/packages/venturecraft/revisionable)

[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](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 `RevisionableTrait` 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/)



## Working with 3rd party Auth / Eloquent extensions



Revisionable has support for Auth powered by

* [**Sentry by Cartalyst**](https://cartalyst.com/manual/sentry).

* [**Sentinel by Cartalyst**](https://cartalyst.com/manual/sentinel).



*(Recommended)* Revisionable can also now be used [as a Trait](#the-new-trait-based-implementation), so your models can continue to extend Eloquent, or any other class that extends Eloquent (like [Ardent](https://github.com/laravelbook/ardent)).



## Installation



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



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



```php

"venturecraft/revisionable": "1.*",

```



Run composer update to download the package



```

php composer.phar update

```



Open config/app.php and register the required service provider  (Laravel 5.x)



```

'providers' => [

	Venturecraft\Revisionable\RevisionableServiceProvider::class,

]

```



Publish the configuration and migrations (Laravel 5.x)



```

php artisan vendor:publish --provider="Venturecraft\Revisionable\RevisionableServiceProvider"

```



Finally, you'll also need to run migration on the package (Laravel 5.x)



```

php artisan migrate

```



For Laravel 4.x users:

```

php artisan migrate --package=venturecraft/revisionable

```



> If you're going to be migrating up and down completely a lot (using `migrate:refresh`), one thing you can do instead is to copy the migration file from the package to your `app/database` folder, and change the classname from `CreateRevisionsTable` to something like `CreateRevisionTable` (without the 's', otherwise you'll get an error saying there's a duplicate class)



> `cp vendor/venturecraft/revisionable/src/migrations/2013_04_09_062329_create_revisions_table.php database/migrations/`



## Docs



* [Implementation](#intro)

* [More control](#control)

* [Format output](#formatoutput)

* [Load revision history](#loadhistory)

* [Display history](#display)

* [Contributing](#contributing)

* [Having troubles?](#faq)





## Implementation



### The new, Trait based implementation (recommended)

> Traits require PHP >= 5.4



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



```php

namespace App;



use \Venturecraft\Revisionable\RevisionableTrait;



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

    use RevisionableTrait;

}

```



> Being a trait, Revisionable can now be used with the standard Eloquent model, or any class that extends Eloquent, such as [Ardent](https://github.com/laravelbook/ardent).



### Legacy class based implementation



> The new trait based approach is backwards compatible with existing installations of Revisionable. You can still use the below installation instructions, which essentially is extending a wrapper for the trait.



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



```php

use Venturecraft\Revisionable\Revisionable;



namespace App;



class Article extends Revisionable { }

```



> Note: This also works with namespaced models.



### 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.



```php

namespace App;



use \Venturecraft\Revisionable\RevisionableTrait;



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

    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.



```php

namespace App;



use \Venturecraft\Revisionable\RevisionableTrait;



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

    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`.



```php

namespace App;



use \Venturecraft\Revisionable\RevisionableTrait;



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

    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

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 for an example of this.)






### Storing Force Delete

By default the Force Delete of a model is not stored as a revision.



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

```php

protected $revisionForceDeleteEnabled = true;

```



In which case, the `created_at` field will be stored as a key with the `oldValue()` value equal to the model creation date and the `newValue()` value equal to `null`.



**Attention!** Turn on this setting carefully! Since the model saved in the revision, now does not exist, so you will not be able to get its object or its relations. 



### 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:

```php

protected $revisionCreationsEnabled = true;

```



## 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:



```php

protected $keepRevisionOf = ['title'];

```



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



```php

protected $dontKeepRevisionOf = ['category_id'];

```



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



### Storing additional fields in revisions



In some cases, you'll want additional metadata from the models in each revision. An example of this might be if you 

have to keep track of accounts as well as users. Simply create your own new migration to add the fields you'd like to your revision model,

add them to your config/revisionable.php in an array like so:



```php 

'additional_fields' => ['account_id', 'permissions_id', 'other_id'], 

```



If the column exists in the model, it will be included in the revision. 



Make sure that if you can't guarantee the column in every model, you make that column ```nullable()``` in your migrations.  



### Events



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

`revisionable.saved` or `revisionable.deleted`.



```php

// app/Providers/EventServiceProvider.php



public function boot()

{

    parent::boot();



    $events->listen('revisionable.*', function($model, $revisions) {

        // Do something with the revisions or the changed model. 

        dd($model, $revisions);

    });

}



```





## 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.,



```php

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.,



```php

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

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

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

```



### Options

Analogous to "boolean", only any text or numeric values can act as a source value (often flags are stored in the database). The format allows you to specify different outputs depending on the value.

Look at this as an associative array in which the key is separated from the value by a dot. Array elements are separated by a vertical line.



```

options:search.On the search|network.In networks

```



### 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

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



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



```php

$article = Article::find($id);

$history = $article->revisionHistory;

```





## 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:



```php

@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:

    ```php

    @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()
    


    Returns the User that was responsible for making the revision. A user model is returned, or false 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()
    


    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()
    


    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.,
    


    ```php

    use Venturecraft\Revisionable\Revisionable;
    


    class Article extends Revisionable

    {

        public function identifiableName()

        {

            return $this->title;

        }

    }

    ```
    


    ### 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

    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:
    


    ```php

    protected $revisionNullString = 'nothing';

    protected $revisionUnknownString = 'unknown';

    ```
    


    ### 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.
    


    ```php

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

    ```
    


    or:
    


    ```php

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

    ```
    


    

    ## Contributing
    


    Contributions are encouraged and welcome; to keep things organised, all bugs and requests should be

    opened in the GitHub issues tab for the main project, at [venturecraft/revisionable/issues](https://github.com/venturecraft/revisionable/issues)
    


    All pull requests should be made to the develop branch, so they can be tested before being merged into the master branch.
    


    

    ## Having troubles?
    


    If you're having troubles with using this package, odds on someone else has already had the same problem. Two places you can look for common answers to your problems are:
    


    * [StackOverflow revisionable tag](https://stackoverflow.com/questions/tagged/revisionable?sort=newest&pageSize=50)

    * [GitHub Issues](https://github.com/VentureCraft/revisionable/issues)
    


    > If you do prefer posting your questions to the public on StackOverflow, please use the 'revisionable' tag.