FriendRepositoryInterface
in
Interface FriendRepositoryInterface.
Tags
Table of Contents
Methods
- addFriend() : bool
- clearFriendSuggestionCache() : void
- countMutualFriends() : int
- countTotalFriends() : int
- deleteUserSuggestionIgnoreData() : void
- getFriendBirthdays() : Paginator
- getFriendIds() : array<string|int, mixed>
- getFriendSuggestion() : array<string|int, mixed>
- getMentions() : Paginator|null
- getMutualFriends() : Collection
- getSuggestion() : array<string|int, mixed>
- getTagSuggestions() : Paginator
- hideUserSuggestion() : bool
- inviteFriendsToItem() : Collection
- inviteFriendToOwner() : array<int, mixed>
- isFriend() : bool
- unFriend() : bool
- viewFriends() : Paginator
- viewMembers() : Paginator|null
- viewProfileFriends() : Paginator
Methods
addFriend()
public
addFriend(User $user, User $owner, bool $hasCheckIsFriend) : bool
Parameters
Tags
Return values
boolclearFriendSuggestionCache()
public
clearFriendSuggestionCache(int $userId, int $ownerId) : void
Parameters
- $userId : int
- $ownerId : int
countMutualFriends()
public
countMutualFriends(int $contextId, int $userId) : int
Parameters
- $contextId : int
- $userId : int
Return values
intcountTotalFriends()
public
countTotalFriends(int $userId) : int
Parameters
- $userId : int
Return values
intdeleteUserSuggestionIgnoreData()
public
deleteUserSuggestionIgnoreData(int $userId) : void
Parameters
- $userId : int
getFriendBirthdays()
public
getFriendBirthdays(User $user, array<string, mixed> $attributes) : Paginator
Parameters
- $user : User
- $attributes : array<string, mixed>
Return values
PaginatorgetFriendIds()
public
getFriendIds(int $userId) : array<string|int, mixed>
Parameters
- $userId : int
Return values
array<string|int, mixed>getFriendSuggestion()
public
getFriendSuggestion(User $context, array<string, mixed> $params) : array<string|int, mixed>
Parameters
- $context : User
- $params : array<string, mixed>
Return values
array<string|int, mixed>getMentions()
public
getMentions(User $context, array<string|int, mixed> $attributes) : Paginator|null
Parameters
- $context : User
- $attributes : array<string|int, mixed>
Return values
Paginator|nullgetMutualFriends()
public
getMutualFriends(int $contextId, int $userId[, int $limit = Pagination::DEFAULT_ITEM_PER_PAGE ]) : Collection
Parameters
- $contextId : int
- $userId : int
- $limit : int = Pagination::DEFAULT_ITEM_PER_PAGE
Return values
CollectiongetSuggestion()
public
getSuggestion(User $context[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $context : User
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getTagSuggestions()
public
getTagSuggestions(User $context, array<string|int, mixed> $attributes) : Paginator
Parameters
- $context : User
- $attributes : array<string|int, mixed>
Return values
PaginatorhideUserSuggestion()
public
hideUserSuggestion(User $context, User $user) : bool
Parameters
Return values
boolinviteFriendsToItem()
public
inviteFriendsToItem(User $context, array<string|int, mixed> $attributes) : Collection
Parameters
- $context : User
- $attributes : array<string|int, mixed>
Return values
CollectioninviteFriendToOwner()
public
inviteFriendToOwner(User $context, array<string, mixed> $attributes) : array<int, mixed>
Parameters
- $context : User
- $attributes : array<string, mixed>
Return values
array<int, mixed>isFriend()
public
isFriend(int|null $userId, int|null $friendId) : bool
Parameters
- $userId : int|null
- $friendId : int|null
Return values
boolunFriend()
public
unFriend(int $userId, int $friendId) : bool
Parameters
- $userId : int
- $friendId : int
Return values
boolviewFriends()
public
viewFriends(User $context, User $owner, array<string, mixed> $attributes) : Paginator
Parameters
Tags
Return values
PaginatorviewMembers()
public
viewMembers(User $context, User $user, User $owner, array<string|int, mixed> $attributes) : Paginator|null
Parameters
Return values
Paginator|nullviewProfileFriends()
public
viewProfileFriends(User $context, User $owner, array<string|int, mixed> $attributes) : Paginator