demency / laravel-friendships
This package gives Eloquent models the ability to manage their friendships.
This package's canonical repository appears to be gone and the package has been frozen as a result.
Installs: 1 000
Dependents: 0
Suggesters: 0
Security: 0
Stars: 20
Watchers: 3
Forks: 8
Open Issues: 4
Requires
- php: >=7.1.3
- illuminate/container: ^5.8|^6.0|^7.0
- illuminate/contracts: ^5.8|^6.0|^7.0
Requires (Dev)
- doctrine/dbal: ^2.10
- fzaninotto/faker: ^1.9
- orchestra/testbench: ^3.8|^4.0|^5.0
- phpunit/phpunit: ^8.0|^9.0
This package is not auto-updated.
Last update: 2020-08-15 07:58:04 UTC
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 demency/laravel-friendships
Publish config and migrations
php artisan vendor:publish --provider="Demency\Friendships\FriendshipsServiceProvider"
Configure the published config in
config\friendships.php
Finally, migrate the database
php artisan migrate
If you wish to for this package to not run migrations you can do so by adding this code in your register
method of your AppServiceProvider
.
use Demency\Friendships\FriendshipsServiceProvider; FriendshipsServiceProvider::$runsMigrations = false;
Setup a Model
use Demency\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);
Get friends using advanced paginated and scoped status
// Methods usages (Status available: pending, denied, blocked and accepted.) (Paginators available: none, default, simple) $user->{status}Friends($resultsPerPage = 0, $paginationType = 'none'); // Example #1: (Get accepted friends using default paginator with 25 results per page). $user->acceptedFriends(25, 'default'); // Example #2: (Get pending friends using simple paginator with 10 results per page). $user->pendingFriends(10, 'simple'); // Example #3: (Get all denied friends without pagination). $user->deniedFriends(); // Example #3: (Get denied friends using default paginator with 30 results per page). $user->blockedFriends(30);
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
Event name | Fired |
---|---|
Demency\Friendships\Events\Sent | When a friend request is sent |
Demency\Friendships\Events\Accepted | When a friend request is accepted |
Demency\Friendships\Events\Denied | When a friend request is denied |
Demency\Friendships\Events\Blocked | When a friend is blocked |
Demency\Friendships\Events\Unblocked | When a friend is unblocked |
Demency\Friendships\Events\Cancelled | When a friendship is cancelled |
Contributing
See the CONTRIBUTING guide.