Events

Monti includes a minimal, custom event system used internally by the framework and available to your own code.

Concepts

An event is identified by its name (a string) and holds a list of listeners. Listeners are added independently of dispatching, and are invoked, in registration order, every time the event is dispatched.

// register a listener
\App\System\Events\Manager::getEvent("my.custom.event")->addListener(function($payload) {
    // ...
});

// dispatch it, passing any number of arguments to the listeners
\App\System\Events\Manager::getEvent("my.custom.event")->dispatch($payload);

Listeners

A listener can be a closure, any other callable, or the fully qualified name of a class exposing a dispatch() method. In this case Monti instantiates the class and calls its dispatch() method with the same arguments:

class SendWelcomeEmail {
    public function dispatch($user) {
        // ...
    }
}

\App\System\Events\Manager::getEvent("users.onSignup")->addListener(SendWelcomeEmail::class);

Use setListener() instead of addListener() to replace every existing listener with a single one.

Events emitted by the framework