[5.8] Suggest resolution when no relationship value is returned #28762
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
mfn
reviewed
Jun 8, 2019
| @@ -413,6 +413,12 @@ protected function getRelationshipFromMethod($method) | |||
| $relation = $this->$method(); | |||
|
|
|||
| if (! $relation instanceof Relation) { | |||
| if (is_null($relation)) { | |||
| throw new LogicException(sprintf( | |||
| '%s::%s must return a relationship instance, but "null" was returned. Was the "return" keyword used?', static::class, $method | |||
There was a problem hiding this comment.
Suggestion:
Was the "return" keyword used?- Is the "return" keyword missing?
GrahamCampbell
changed the title
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.
By far one of the most common issues I've seen people new to Laravel ask for help with is when they forget the
returnkeyword when defining relationships, to the point where there are nearly 3000 results on Google when you search for the exception.I guess it comes from the fact builder methods don't have to return a value, and they're often talked about alongside relationships.
All this PR does is put a bit more information and a suggestion in the exception's text to point them in the right direction.