rojtjo/laravel-auto-subscriber

laravel-auto-subscriber

0.3.1 2023-12-04 17:16 UTC

This package is auto-updated.

Last update: 2024-11-04 19:12:04 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

Automatically subscribe to all events for which your subscriber contains a handler. Under the hood we use reflection to detect all listeners defined on the subscriber.

Installation

You can install the package via composer:

composer require rojtjo/laravel-auto-subscriber

Usage

All you have to do is use the Rojtjo\LaravelAutoSubscriber\AutoSubscriber trait on your subscriber class. Also make sure to register your subscriber in the EventServiceProvider like you're used to.

Example

use Rojtjo\LaravelAutoSubscriber\AutoSubscriber;

final class UserNotifier
{
    use AutoSubscriber;

    public function welcomeUser(UserCreated $event): void
    {
        // Send welcome notification..
    }
}

This would equivalent to a handwritten subscriber like shown below.

use Illuminate\Contracts\Events\Dispatcher;

final class UserNotifier
{
    public function subscribe(Dispatcher $events)
    {
        $events->listen(UserCreated::class, [$this, 'welcomeUser']);
    }

    // ...
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.