Fix return types of firstWhere and first of BelongsToMany and HasManyThrough
#51219
Conversation
This file contains 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
SanderMuller
changed the title
firstWhere and first of BelongsToMany and HasManyThrough @SanderMullerfirstWhere and first of BelongsToMany and HasManyThrough
|
We might want to target this to 10.x instead |
SanderMuller
commented
Apr 26, 2024
| @@ -784,7 +784,7 @@ public function findOr($id, $columns = ['*'], ?Closure $callback = null) | |||
| * @param mixed $operator | |||
| * @param mixed $value | |||
| * @param string $boolean | |||
| * @return \Illuminate\Database\Eloquent\Model|static | |||
There was a problem hiding this comment.
I am also not sure why this returns |static, in which case does it return an instance of BelongsToMany?
SanderMuller
commented
Apr 26, 2024
| @@ -784,7 +784,7 @@ public function findOr($id, $columns = ['*'], ?Closure $callback = null) | |||
| * @param mixed $operator | |||
| * @param mixed $value | |||
| * @param string $boolean | |||
| * @return \Illuminate\Database\Eloquent\Model|static | |||
| * @return \Illuminate\Database\Eloquent\Model|static|null | |||
There was a problem hiding this comment.
Suggested change
| * @return \Illuminate\Database\Eloquent\Model|static|null | |
| * @return \Illuminate\Database\Eloquent\Model|null |
Unless I'm mistaken, this should be correct
| @@ -795,7 +795,7 @@ public function firstWhere($column, $operator = null, $value = null, $boolean = | |||
| * Execute the query and get the first result. | |||
| * | |||
| * @param array $columns | |||
| * @return mixed | |||
| * @return \Illuminate\Database\Eloquent\Model|static|null | |||
There was a problem hiding this comment.
Suggested change
| * @return \Illuminate\Database\Eloquent\Model|static|null | |
| * @return \Illuminate\Database\Eloquent\Model|null |
| @@ -320,7 +320,7 @@ public function updateOrCreate(array $attributes, array $values = []) | |||
| * @param mixed $operator | |||
| * @param mixed $value | |||
| * @param string $boolean | |||
| * @return \Illuminate\Database\Eloquent\Model|static | |||
| * @return \Illuminate\Database\Eloquent\Model|static|null | |||
There was a problem hiding this comment.
Suggested change
| * @return \Illuminate\Database\Eloquent\Model|static|null | |
| * @return \Illuminate\Database\Eloquent\Model|null |
| @@ -331,7 +331,7 @@ public function firstWhere($column, $operator = null, $value = null, $boolean = | |||
| * Execute the query and get the first related model. | |||
| * | |||
| * @param array $columns | |||
| * @return mixed | |||
| * @return \Illuminate\Database\Eloquent\Model|static|null | |||
There was a problem hiding this comment.
Suggested change
| * @return \Illuminate\Database\Eloquent\Model|static|null | |
| * @return \Illuminate\Database\Eloquent\Model|null |
There was a problem hiding this comment.
We don't use the ? in docblocks itself. null is what we use.
There was a problem hiding this comment.
We don't use the
?in docblocks itself.nullis what we use.
Updated!
There was a problem hiding this comment.
@driesvints can you confirm in static can be dropped? Then I can create a follow-up PR for it
There was a problem hiding this comment.
I'd just leave things be for now. Thanks
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
The current return types of
firstWheredoes not includenull, while it ends up calling->first()which can returnnull(when there's no results).This change improves the IDE intellisense and fixes false positives static analyser errors, for example this Larastan error: