Events

Introduction

Maravel’s events provides a simple observer implementation, allowing you to subscribe and listen for events in your application. Event classes are typically stored in the app/Events directory, while their listeners are stored in app/Listeners.

Differences From Maravelith

In general, events in Maravel function exactly like they do in the full-stack Maravelith framework, so please review the full Maravelith documentation. Event broadcasting is even supported in Maravel, which allows you to listen for your server side events in your client-side JavaScript. However, there are a few minor differences which warrant discussion.

Generators

In Maravel, THERE ARE also generator commands to generate events and listeners for you, see Artisan. These example classes provide the basic structure of every event and listener.

Registering Events / Listeners

Like the full Maravelith framework, the EventServiceProvider included with your Maravel application provides a convenient place to register all event listeners. The listen property contains an array of all events (keys) and their listeners (values). Of course, you may add as many events to this array as your application requires:

/**
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    'App\Events\ExampleEvent' => [
        'App\Listeners\ExampleListener',
    ],
];

Firing Events

You may use the event helper function or Event facade to fire events throughout your Maravel application. Again, these functions behave exactly like their full Maravelith framework equivalent:

event(new ExampleEvent);

Event::dispatch(new ExampleEvent);

Model Observers

You may place your Observer in Observers folder (see \Laravel\Lumen\Providers\EventServiceProvider::discoverEventsAsObserversWithin), set auto-discovery to true in EventServiceProvider:

/**
* Determine if events as observers and listeners should be automatically discovered.
*/
public function shouldDiscoverEventsAsObservers(): bool
{
    return true;
}

and the artisan event:cache command will auto-register it, no need to call observe.

You can also generate observers, see Artisan.

Note: In bootstrap/app.php, the $app->withEloquent(); MUST be placed AFTER $app->register(App\Providers\EventServiceProvider::class); `