grummfy/laravel-restorable-events

This library is an help to store and restore events for laravel.

Laravel restorable events

This library is an help to store and restore events., _(*1)

Compatible with laravel 5.5., _(*2)

Install

Install the dependencies, _(*3)

composer require grummfy/laravel-restorable-events

Publish the configuration, _(*4)

php artisan vendor:publish --tag=config --provider=Grummfy\RestorableEvents\RestorableEventsProvider

Create the model class, using the trait EventStorableTrait. See the example directory if you need it., _(*5)

Edit your Providers\EventServiceProvider.php: * Use the trait EventServiceProviderTrait * You will also require to have this variable set, with at least theses values:, _(*6)

    protected $listen = [
        JsonSerializableContract::class => [
            StorableEventListener::class,
        ],
    ];

This will allow the usage of the storage of the event on the fly., _(*7)

Usage

On any event you want to store, just extends RestorableEvent or implements the two interface RestorableContract, JsonSerializableContract. The rest is made by the listener., _(*8)

If you need to hook some change, when an event is restored, just implements the restored method available on it., _(*9)

If you require you could also prioritise the events. Just fill the $priorities value from the trait on the service listener., _(*10)

What's stored

In the event CreditRefilled is dispatched, it will be saved, but for each eloquent model, only the id and the name of the model will be saved., _(*11)

TODO

• unit test
• QA tools
  • travis
  • styleci
  • scrutinizer
  • ...