[WIP] Add access to query builder with requests() and friendships() method in friendable trait

[stephane-monnot]

No description provided.

[stephane-monnot]

I have a question, method getBlockedFriendships() should return all blocked friendships ? hasBlocked and isBlockedBy ? Same question for getAcceptedFriendships()

[hootlex]

All of getBlockedFriendships, getAcceptedFriendships, getDeniedFriendships, and getPendingFriendships return incoming and outgoing friendships.

[barryvdh]

This PR seems to do a bit much, but it would be nice to be able to query the friendships and add own scopes/filters/orders. So get the query builder instead of the fetched collection.

[hootlex]

@shinbuntu @barryvdh Yeah, accessing the query builder would make the package much more flexible.
This PR is based on this discussion but seems to be abandoned. :/

The basic idea is that:

// returns the query builder
$user->friendships(); 

// query requests from others users than the current
$user->friendships()->incoming(); 

// returns all incoming friendships
$user->friendships()->incoming()->get(); 

[barryvdh]

Hmm, but doesn't the morphMany work one-way? Eg. only the friendships where the current user is the sender, not the other way around?

[barryvdh]

Oh friendships are 'requests' and friends are connected friends, right?
Why not call it friendshipRequest instead of friendship? Imho the difference between friends and friendships is not so clear.

[hootlex]

@barryvdh Yup, it's actually too confusing. I think that the idea is that friendships() will return all friendships (pending, accepted, rejected, etc) and friends() will return the User models (ex $user->friends()->blocked() returns all the Users that have been blocked).

I can't decide how to name the methods/scopes in the new version of the API.
Maybe something like $user->friendships()->accepted()->getFriends() and remove friends() entirely.

Do you have anything to suggest?

[barryvdh]

I think friends /friendships or connections when accepted. Requests can be all. $user->requests()->pending(). Or more specific friendRequests()

[stephane-monnot]

Both "friends" method and "requests" method will return a queryBuilder to get a collection of users ? Or "requests" method will return a queryBuilder to get a collection of FriendshipRequest (Actually Friendship model) ?

[hootlex]

Hmm, maybe we can keep only friendRequests or friendships which will return User Models. I don't think there is a need to return Friendship models

What do you think about that?

[stephane-monnot]

I added friendships() to get friends querybuilder, deprecated friends method and added protected friendshipRequests to keep morphMany relationship with Friendship Model.

For "$user->requests()->pending()", the requests should be incoming only or incoming+outgoing ?

[hootlex]

I liked your idea with the incoming and outgoing scopes.
If we keep them, then $user->requests()->pending() should return all pending requests and $user->requests()->incoming()->pending() should return only the incoming ones.

[stephane-monnot]

I added some scopes, but I have encountered some difficulties with outgoing and incoming scopes because I can't get User object in the scopes.

Maybe a solution consists to add named scopes and remove one scope to filter. (See where clauses in findRequests)

Examples:

• defaultScope1: orWhereSender($this)
• defaultScope2: orWhereRecipient($this)

When I call outgoing(), it will remove scope2 and add scope1.
When I call incoming(), it will remove scope1 and add scope2.

Better solution ?

[hootlex]

I don't know if there is a better way to get the User. I can review it tomorrow and let you know if I find a better solution.

[stephane-monnot]

Thank you. I will check tomorrow night.

[hootlex]

I couldn't find any way to get user withing incoming/outgoing scopes.
One thing that we could to, is to make incoming/outgoing functions withing Friendable trait.
Also, your solution sounds good to me.

[hootlex]

@stephane-monnot Let me know when you are done.

[stephane-monnot]

You can already check if you have time. You can quickly see changes in this commit.

Maybe we should deprecate some methods, update the documentation and make a deprecated section with all deprecated methods.

What do you think about that? Do you have any suggestions ?

[hootlex]

Looks awesome! Though, Direction::INCOMING in $user->requests(Direction::INCOMING) is kinda scary...
I am thinking to bump version to 2.0 after I merge this.

Do you prefer requests as the public method over friendRequests?

[barryvdh]

To be honest, I liked the incoming() scope more then this constant.

[stephane-monnot]

Me too. I will try to find a solution.

[hootlex]

@stephane-monnot I can't wait to write proper docs for V2.

[stephane-monnot]

Sorry, I have a lot of work. I will work on it soon.

[hootlex]

@stephane-monnot sure, no problem. Just wanted to let u know 😄