cuitcode / laravel-friendships
This package gives Eloquent models the ability to manage their friendships.
Requires
- php: ^8.0
Requires (Dev)
- doctrine/dbal: ^2.5
- fakerphp/faker: ^1.17
- laravel/laravel: ^8.0
- mockery/mockery: ^1.4.2
- orchestra/testbench: ^6.18
- phpunit/php-code-coverage: ^9.2
- phpunit/phpunit: ^9.3
- symfony/console: ^5.2.0
README
This package gives Eloquent models the ability to manage their friendships. You can easily design a Facebook like Friend System.
Models can:
- Send Friend Requests
- Accept Friend Requests
- Deny Friend Requests
- Block Another Model
- Group Friends
Installation
First, install the package through Composer.
composer require cuitcode/laravel-friendships
If you are using Laravel < 5.5, you need to add Cuitcode\Friendships\FriendshipsServiceProvider to your config/app.php
providers array:
Cuitcode\Friendships\FriendshipsServiceProvider::class,
Publish config and migrations
php artisan vendor:publish --provider="Cuitcode\Friendships\FriendshipsServiceProvider"
Configure the published config in
config\friendships.php
Finally, migrate the database
php artisan migrate
Setup a Model
use Cuitcode\Friendships\Traits\Friendable; class User extends Model { use Friendable; ... }
How to use
Check the Test file to see the package in action
Send a Friend Request
$user->befriend($recipient);
Accept a Friend Request
$user->acceptFriendRequest($sender);
Deny a Friend Request
$user->denyFriendRequest($sender);
Remove Friend
$user->unfriend($friend);
Block a Model
$user->blockFriend($friend);
Unblock a Model
$user->unblockFriend($friend);
Check if Model is Friend with another Model
$user->isFriendWith($friend);
Check if Model has a pending friend request from another Model
$user->hasFriendRequestFrom($sender);
Check if Model has already sent a friend request to another Model
$user->hasSentFriendRequestTo($recipient);
Check if Model has blocked another Model
$user->hasBlocked($friend);
Check if Model is blocked by another Model
$user->isBlockedBy($friend);
Get a single friendship
$user->getFriendship($friend);
Get a list of all Friendships
$user->getAllFriendships();
Get a list of pending Friendships
$user->getPendingFriendships();
Get a list of accepted Friendships
$user->getAcceptedFriendships();
Get a list of denied Friendships
$user->getDeniedFriendships();
Get a list of blocked Friendships
$user->getBlockedFriendships();
Get a list of pending Friend Requests
$user->getFriendRequests();
Get the number of Friends
$user->getFriendsCount();
Get the number of Pendings
$user->getPendingsCount();
Get the number of mutual Friends with another user
$user->getMutualFriendsCount($otherUser);
Friends
To get a collection of friend models (ex. User) use the following methods:
Get Friends
$user->getFriends();
Get Friends Paginated
$user->getFriends($perPage = 20);
Get Friends of Friends
$user->getFriendsOfFriends($perPage = 20);
Collection of Friends in specific group paginated:
$user->getFriends($perPage = 20, $group_name);
Get mutual Friends with another user
$user->getMutualFriends($otherUser, $perPage = 20);
Friend groups
The friend groups are defined in the config/friendships.php
file.
The package comes with a few default groups.
To modify them, or add your own, you need to specify a slug
and a key
.
// config/friendships.php ... 'groups' => [ 'acquaintances' => 0, 'close_friends' => 1, 'family' => 2 ]
Since you've configured friend groups, you can group/ungroup friends using the following methods.
Group a Friend
$user->groupFriend($friend, $group_name);
Remove a Friend from family group
$user->ungroupFriend($friend, 'family');
Remove a Friend from all groups
$user->ungroupFriend($friend);
Get the number of Friends in specific group
$user->getFriendsCount($group_name);
To filter friendships
by group you can pass a group slug.
$user->getAllFriendships($group_name); $user->getAcceptedFriendships($group_name); $user->getPendingFriendships($group_name); ...
Events
This is the list of the events fired by default for each action
Contributing
See the CONTRIBUTING guide.