Support for constructor property promotion on events - improves autocompletion and static analyzer support

[gehrisandro]

The current behaviour when firing an event is to provide named parameters, but there is no autocompletion which helps to find the correct parameter names as the "magic" fire() does not have any information about the properties available in the event.

What I currently do is to use "Constructor property promotion" to specify the arguments and then have a fire method on the event to fire the event after creation via the constructor.

This is how the change looks like when firing an event:

// Before
MyEvent::fire(
    user_id: auth()->user()->id, // The IDE has no clue if `user_id` exists
);

// After
new MyEvent(
    user_id: auth()->user()->id, // The IDE knows that `user_id` exists and what type it expects
)->fire();

The benefit is to have autocompletion available and support for static analysers.

What it technically needs is a __call implementation on the event class to forward the fire() call to a new PendingEvent instance:

public function __call(string $name, array $arguments)
{
    return new PendingEvent($this)->$name(...$arguments);
}

Any thoughts on this? Do I overlook something here which maybe causes me trouble in the future?

[inxilpro]

Right now you can do verb(new MyEvent(...)) and that works just fine. In general, we've avoided adding methods to events themselves because we want you to own as much of it as possible. Does that seem like an OK compromise?

[gehrisandro]

Oh, I wasn't aware of the verb(...) helper at all. 👀 Thank you!

From an autocompletion standpoint, this works perfectly fine for me. Nevertheless, I think new MyEvent(...)->fire() reads more natural than verb(new MyEvent(...)).

If you don't want to add this to the library, no problem for me. I can add it locally in my project.

[nick-potts]

I personally would love to see something like this. I've had it backfire so much at me that I eventually I never used the ::fire or ::commit syntax. Not really a fan of the magic.