Make types of parameter of join method consistent in the Query Builder - #48386
Merged
taylorotwell merged 1 commit intoSep 13, 2023
Conversation
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There is a consistency problem with the typing of the $second parameter in functions that perform joins.
In the JoinClause class, the "on" function accepts an Expression in the $second parameter:
@param \Illuminate\Contracts\Database\Query\Expression|string|null $secondWhich is perfectly normal.
However, in the "join" function of the "Builder" class, the "JoinClause::on" function is called with the $second parameter, which is not typed "Expression".
At runtime, you can pass an expression in $second, which poses no problem and the request is executed correctly.
However, if you use a static analysis tool like phpstan, the compatibility problem appears:
My suggestion is to add the "Expression" type to the $second parameters in order to guarantee type consistency in the Query Builder at this level.