Package Data | |
---|---|
Maintainer Username: | shooka |
Maintainer Contact: | nicolaiostby@gmail.com (Nicolai Østby) |
Package Create Date: | 2015-09-05 |
Package Last Update: | 2017-05-10 |
Home Page: | |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-12-16 15:03:58 |
Package Statistics | |
---|---|
Total Downloads: | 6,691 |
Monthly Downloads: | 0 |
Daily Downloads: | 0 |
Total Stars: | 6 |
Total Watchers: | 2 |
Total Forks: | 2 |
Total Open Issues: | 0 |
Have you ever wondered where to put your eloquent model events? It is now easier than ever to apply listeners to your models.
Add this package to your Laravel project by running:
composer require shooka/laravel-modelevents 0.3.*
To publish the necessary files, add the ServiceProvider to the array of providers in config/app.php
:
Shooka\ModelEvents\ServiceProvider::class,
Next, publish the files by running:
php artisan vendor:publish --provider="Shooka\ModelEvents\ServiceProvider"
This publishes two files:
ModelEvents/UserEvent.php
file that contains a dummy class that shows what future ModelEvent
s are supposed to look like.Providers/ModelEventServiceProvider.php
with an empty array of listeners that maps actual Eloquent model events to the ModelEvent
classes.As the new ModelEventServiceProvider
has been published, you can add it to the array of providers:
App\Providers\ModelEventServiceProvider::class,
Don't forget to remove the original one from the array:
Shooka\ModelEvents\ServiceProvider::class,
This package is making use of some of the great features of Laravel which means that it is very easy to use in both new and existing Laravel projects.
The events that are supported out of the box are the standard Laravel model events:
creating
, created
,
updating
, updated
,
saving
, saved
,
deleting
, deleted
,
restoring
, and restored
If you want to define any custom events, they should be added to the $observables array:
class Product extends Model
{
protected $observables = [
'sold',
'shipped',
'returned',
...
];
}
Those events are now observable in the ModelEvent
:
class ProductEvent extends ModelEvent
{
public function returned($product) {
// Increase stock count
}
}
To add a listener to an eloquent model, just map the model to a ModelEvent
in the ModelEventServiceProvider
:
protected $listeners = [
\App\Product::class => \App\ModelEvents\ProductEvent::class,
];
The ModelEvent
could be placed anywhere, but is in this example put in the ModelEvents
folder published by the command from the Installation chapter.