How-to-Handle-Multiple-Events-with-a-Single-Listener-in-Laravel

发表于
佛是过来人，人是未来佛，我也曾如你般天真。

Laravel provides a simple way to declare event listeners out of the box via the EventServiceProvider class.

Here’s a quick example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php
 
class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        LoginEvent::class => [
            HandleLoginListener::class
        ],
    ];
}

With the above, anytime the LoginEvent is fired, the handle() method of the HandleLoginListener class will be called. Pretty simple, right?

But what if you have dozens or even hundreds of events that you want to all go through the same handler?

One option would be to list them out individually in the EventServiceProvider class.

Yikes! What if you forget to add the listener when you add a new event?

Another option would be to listen to an interface, and have your events implement the interface.

Here’s an example interface:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// App\Events\NotifiableEvent.php
 
<?php
 
namespace App\Events;
 
interface NotifiableEvent
{
    /**
     * Returns the display name of the event.
     *
     * @return string
     */
    public function getEventName(): string;
 
    /**
     * Returns the description of the event.
     *
     * @return string
     */
    public function getEventDescription(): string;
}

And here’s an example event, that implements the interface:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// App\Events\CreatedApplicationMember.php
 
<?php
 
namespace App\Events;
 
class CreatedApplicationMember implements NotifiableEvent
{
    public function getEventName(): string
    {
        return 'Created Application Member';
    }
 
    public function getEventDescription(): string
    {
        return 'Fired whenever a new Application Member is added to your Application.';
    }
 
    // constructor and stuff goes here...

Then in EventServiceProvider, you can listen for the interface instead of the specific event classes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php
 
class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        NotifiableEvent::class => [
            SendEventNotification::class
        ],
    ];
}

Now anytime an event that implements the NotifiableEvent interface is dispatched, the SendEventNotification listener will be called.

https://owenconti.com/posts/how-to-handle-multiple-events-with-a-single-listener-in-laravel