[8.x] Adds a simple where helper for querying relations

[DarkGhostHunter]

What?

This is sugar for whereHas() for simple where clauses.

// Before:
User::whereHas('posts', function ($query) {
    $query->where('published_at', '>', now());
})->get();

// After
User::whereRelation('posts', 'published_at', '>', now())->get();

How?

Basically creates the whereRelation() and orWhereRelation() helpers, and whereMorphRelation() and orWhereMorphRelation() for morph relations. Since these use the where() method underneath, you can do advanced things:

Comment::whereMorphRelation('commentable', '*', [
    'is_public' => true,
    'is_vip' => false,
])->get();

Why?

Removes code complexity by making the query more readable when dealing with simple where clauses over relations.

Breaking Changes

None - it's merely and additive PR.

[deleugpn]

I think this one can count as a "fixed papercut" and Taylor can take the day off 😄

[DarkGhostHunter]

I think this one can count as a "fixed papercut" and Taylor can take the day off 😄

Sorry I'm too retarded to understand.

[rodrigopedra]

@DarkGhostHunter he is making a reference to this tweet from Taylor:

Laracon is September 1st. I’m trying to make a developer experience improvement to Laravel every single day leading up to the conference. What do I improve today?

link to tweet: https://twitter.com/taylorotwell/status/1427286854584393740

And, since then Taylor is making a PR each day to fix small annoyances for developers (aka papercut) suggested in that thread.

So, I think he means your PR is such a good improvement that Taylor can take a day off because of it.

[DarkGhostHunter]

@DarkGhostHunter he is making a reference to this tweet from Taylor:

Laracon is September 1st. I’m trying to make a developer experience improvement to Laravel every single day leading up to the conference. What do I improve today?

link to tweet: https://twitter.com/taylorotwell/status/1427286854584393740

And, since then Taylor is making a PR each day to fix small annoyances for developers (aka papercut) suggested in that thread.

So, I think he means your PR is such a good improvement that Taylor can take a day off because of it.

Thanks, I feel less dumber now.

[DarkGhostHunter]

I purposely left out whereRelationHas() (and its variants). This was basically syntax sugar for a nested whereHas() and whereKey().

For example, I use this to get all the Post that use one single image.

$image = Image::find(3)

// Before
$posts = Post::whereHas('images', function ($query) use ($image) {
    $query->whereKey($image);
});

// After
$posts = Post::whereRelationHas('images', $image)->get();

I would prefer whereRelationContains() nonetheless, but feels too long.

[Geovanek]

Amazing.

Now all that's left is to put it in the documentation.

[driesvints]

@Geovanek feel free to send in a PR 👍

[aneeskhan47]

@DarkGhostHunter can you also do a helper for withCount withSum etc, so i don't have to write query closures 😄

[binaryk]

Nice sugar here, but is it backward compatible? What if you have a column called relation in your User model?

The User::whereRelation('posts') was translated into where users.relation = 'posts' will this still be working?

[DarkGhostHunter]

Same with ‘whereDate’ and others: use the ‘where’ method when possible. Italo Baeza C.

…

El 08-09-2021, a la(s) 05:25, Lupacescu Eduard ***@***.***> escribió:  Nice sugar here, but is it backward compatible? What if you have a column called relation in your User model? The User::whereRelation('posts') was translated into where users.relation = 'posts' will this still be working? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

[YaakovR]

@DarkGhostHunter Seems like whereRelation can't be passed "BETWEEN" as an operator. There also is currently is no whereRelationBetween function. Perhaps it can be added?

[robsontenorio]

@DarkGhostHunter is there any way to make it work with IN operator?

 return $query->whereHas('posts', function (Builder $query) use ($status) {
            $query->whereIn('status', $status);
        });

[DarkGhostHunter]

NOPE.