[11.x] Allow multiple events to be dispatched at once

[mateusjatenee]

A common use case I have for events is dispatching several at once. For example, I might have models store events to be published at a later time (e.g outside a transaction).

DB::transaction(function () {
    $cart->doSomeAction(); // adds an event
    $cart->finalize(); // adds another event
});

Event::dispatchMany($cart->flushEvents());

It also supports an array syntax to keep it similar to dispatch:

Event::dispatchMany([
    'foo' => [1, 'payload'],
    'bar' => [2', 'more payload']
]);

This PR provides simple syntatic sugar for that use case.

[GrahamCampbell]

I don't like this, and in any case, we can't change the contract on 10.x.

[GrahamCampbell]

why do we care if there are string keys?

[mateusjatenee]

To support something similar to the dispatch('key', 'payload') syntax. e.g:

Event::dispatchMany([
    'event' => [1, 2, 3]
]);

[mateusjatenee]

I don't like this, and in any case, we can't change the contract on 10.x.

my bad — I updated the target to master

[mabdullahsari]

I have had similar needs in the past. 👍

[davorminchorov]

Same, it allows for better control when events should be dispatched in complex workflows / use cases.

[Angel5a]

What about halting and getting response? See dispatch() signature.

[mateusjatenee]

Yeah — I didn't know if it made a lot of sense to get a response from dispatching multiple events. Maybe return an array if $halt = true?

[mpyw]

I don't like this. Probably you need $afterCommit feature.

https://laravel.com/docs/10.x/events#queued-event-listeners-and-database-transactions

[mateusjatenee]

I don't like this. Probably you need $afterCommit feature.

You're not wrong — afterCommit is a possible way to solve this. There are 2 caveats IMO:

• Some people do not like to publish events from within models, etc
• When using afterCommit, the event is still published to the bus — so if you have a non-queued listener, or if the listener is not set to be processed after a transaction is committed, it will be a problem. Also, the event still gets published to the bus (so Event::assertNotDispatched(EventThatWouldNotHaveBeenDispatched::Class) would fail.

[taylorotwell]

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If possible, please consider releasing your code as a package so that the community can still take advantage of your contributions!

If you feel absolutely certain that this code corrects a bug in the framework, please "@" mention me in a follow-up comment with further explanation so that GitHub will send me a notification of your response.