[8.x] Clarify local scope return type #7372
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.
The docs currently state:
But in reality, the
callScope method
expects scopes to modify the provided Eloquent builder object. If you were to, in fact, return a new builder for some reason, it would break theaddNewWheresWithinGroup
functionality and potentially have other unexpected behavior (since this method is operating on the original query builder, not the one from the result of calling the scope).This PR updates the docs to:
And also changes one of the code samples to demonstrate the
void
return version of a named scope.