Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] Clarify local scope return type #7372

Merged
merged 1 commit into from
Oct 19, 2021

Conversation

inxilpro
Copy link
Contributor

The docs currently state:

Scopes should always return a query builder instance

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 the addNewWheresWithinGroup 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:

Scopes should always return the same query builder instance or void

And also changes one of the code samples to demonstrate the void return version of a named scope.

@taylorotwell taylorotwell merged commit df38fa8 into laravel:8.x Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants