laravel-friendships

This package gives Eloquent models the ability to manage their friendships.

Subscribe to updates I use laravel-friendships


Statistics on laravel-friendships

Number of watchers on Github 420
Number of open issues 20
Average time to close an issue 15 days
Main language PHP
Average time to merge a PR 1 day
Open pull requests 12+
Closed pull requests 6+
Last commit over 1 year ago
Repo Created almost 3 years ago
Repo Last Updated 9 months ago
Size 116 KB
Organization / Authorhootlex
Latest Releasev1.0.23
Contributors1
Page Updated
Do you use laravel-friendships? Leave a review!
View open issues (20)
View laravel-friendships activity
View on github
Latest Open Source Launches
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating laravel-friendships for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

Laravel 5 Friendships

Build Status Code Climate Test Coverage Total Downloads Version Software License Join the chat at https://gitter.im/laravel-friendships/Lobby

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 hootlex/laravel-friendships

Then include the service provider inside config/app.php.

'providers' => [
    ...
    Hootlex\Friendships\FriendshipsServiceProvider::class,
    ...
];

Publish config and migrations

php artisan vendor:publish --provider="Hootlex\Friendships\FriendshipsServiceProvider"

Configure the published config in

config\friendships.php

Finally, migrate the database

php artisan migrate

Setup a Model

use Hootlex\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 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

Event name Fired
friendships.sent When a friend request is sent
friendships.accepted When a friend request is accepted
friendships.denied When a friend request is denied
friendships.blocked When a friend is blocked
friendships.unblocked When a friend is unblocked
friendships.cancelled When a friendship is cancelled

Contributing

See the CONTRIBUTING guide.

laravel-friendships open issues Ask a question     (View All Issues)
  • about 2 years getFriendRequests with recipient object
  • about 2 years Groups in config
  • about 2 years getPendingFriends
laravel-friendships open pull requests (View All Pulls)
  • Added three new methods for limit and pagination when getting Friends(accepted)
  • [WIP] Add access to query builder with friends() and friendships() method in friendable trait
  • Add method to find mutual friends
  • Add user's personal groups (acquaintances, family, etс.) support
  • Improve the travis build
  • [WIP] Add deprecate notes
  • Upd Groups config, add getGroupsFor()
  • Physio patch 1
  • Update readme.md
  • Ability to specify fields && code alignment
  • Incoming and outgoing friend requests
  • Allow models to get friendships requested by others
laravel-friendships list of languages used
laravel-friendships latest release notes
v1.0.23 v1.0.23

Use complete namespace for Event

v1.0.22 v1.0.22
  • Support for Laravel 5.4
  • Improve PHPdoc / IDE autocomplete
v1.0.21 v1.0.21
  • Added Laravel 5.3 compatibility
  • Added method to check if a user has sent a friend request to another user (hasSentFriendRequestTo).
  • Improved Travis build
Other projects in PHP