Fireable
An elegant way to trigger events based on attributes changes.
Installation
Install package through Composer
$ composer require envant/fireable
Usage
- Add the
FireableAttributestrait to your model - Define the attributes with specified events via the
protected $fireableAttributesproperty on the model
Example
Let’s say we need to trigger specified events when specific model attributes are updated.
For example, you need to notify user when he gets an "approved" status. Instead of observing model’s "dirty" attributes and firing events manually we could do it more elegantly by assigning specified events to attributes or even certain values of attributes.
class User extends Authenticatable { use FireableAttributes; protected $fireableAttributes = [ 'status' => [ 'approved' => UserApproved::class, 'rejected' => UserRejected::class, ], ]; }
Also you may not need to track certain values, so you can assign an event directly to an attribute itself. So, in the example below, each time the user’s email is changed, the appropriate event will be fired.
class User extends Authenticatable { use FireableAttributes; protected $fireableAttributes = [ 'email' => EmailUpdated::class, ]; }
Change log
Please see the changelog for more information on what has changed recently.
Testing
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email author email instead of using the issue tracker.
Credits
License
license. Please see the license file for more information.
