[10.x] Fix Dispatcher::until
return type
#47585
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It appears the until method always returns whatever gets returned from a listener or null if nothing is returned from any listener.
As you can see the until method returns the result of the dispatch method with parameter
$halt
=true
:https://github.com/laravel/framework/blob/10.x/src/Illuminate/Events/Dispatcher.php#L222
And the behaviour of dispatch with
$halt
=true
is as follows:null
, that value will be early returned. https://github.com/laravel/framework/blob/10.x/src/Illuminate/Events/Dispatcher.php#L254null
https://github.com/laravel/framework/blob/10.x/src/Illuminate/Events/Dispatcher.php#L268I was considering adding a conditional return type to the dispatch method based on the
halt
boolean. I however thought they weren't used anywhere else in the framework and decided to omit this. Please let me know if this is wanted.