PHPackages                             jawadabbass/laravel-friendships - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. jawadabbass/laravel-friendships

ActiveLibrary[Utility & Helpers](/categories/utility)

jawadabbass/laravel-friendships
===============================

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

07PHP

Since Mar 16Pushed 4y ago1 watchersCompare

[ Source](https://github.com/jawadabbass/laravel-friendships)[ Packagist](https://packagist.org/packages/jawadabbass/laravel-friendships)[ RSS](/packages/jawadabbass-laravel-friendships/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Laravel 8 Friendships Package
=============================

[](#laravel-8-friendships-package)

[![Build Status](https://camo.githubusercontent.com/97993cfccdf469373d2ea12c06121ec68e8719d222a1c49d18386f60dc21630e/68747470733a2f2f7472617669732d63692e6f72672f6a617761646162626173732f6c61726176656c2d667269656e6473686970732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/jawadabbass/laravel-friendships) [![codecov](https://camo.githubusercontent.com/cdde6f4b6e529303625e701e84dbe1e0786ff5f5296098485b7c3aab67eb8767/68747470733a2f2f636f6465636f762e696f2f67682f6a617761646162626173732f6c61726176656c2d667269656e6473686970732f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/jawadabbass/laravel-friendships) [![Code Climate](https://camo.githubusercontent.com/835751503634666cae2ae6150a7916ce674c506ecdc7949db899cb9aec88bd9a/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6a617761646162626173732f6c61726176656c2d667269656e6473686970732f6261646765732f6770612e737667)](https://codeclimate.com/github/jawadabbass/laravel-friendships) [![Test Coverage](https://camo.githubusercontent.com/db8e6c7f2b21534af356de0aa74c03ab6ddd4c182f0cec00d85b26876af06ed5/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6a617761646162626173732f6c61726176656c2d667269656e6473686970732f6261646765732f636f7665726167652e737667)](https://codeclimate.com/github/jawadabbass/laravel-friendships/coverage) [![Total Downloads](https://camo.githubusercontent.com/d2b5ce39dc8fd1b5751f07ef1eabc969c339f88062747a651dcc6bf175ec4574/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a617761646162626173732f6c61726176656c2d667269656e6473686970732e7376673f7374796c653d666c6174)](https://packagist.org/packages/jawadabbass/laravel-friendships) [![Version](https://camo.githubusercontent.com/ce0687bea79cb600c3f69d43d0810d60a6ced9ad1aa28112a284912b338e372d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6a617761646162626173732f6c61726176656c2d667269656e6473686970732e7376673f7374796c653d666c6174)](https://packagist.org/packages/jawadabbass/laravel-friendships) [![Software License](https://camo.githubusercontent.com/f251623e510f5909f16ae3f4e6e548dac11340b9fde1a99be26b015b39272c00/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c6174)](LICENSE)

This package gives Eloquent models the ability to manage their friendships. You can easily design a Facebook like Friend System.

Models can:
-----------

[](#models-can)

- Send Friend Requests
- Accept Friend Requests
- Deny Friend Requests
- Block Another Model
- Group Friends

Installation
------------

[](#installation)

First, install the package through Composer.

```
composer require jawadabbass/laravel-friendships
```

Publish config and migrations

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

```

Configure the published config in

```
config\friendships.php

```

Finally, migrate the database

```
php artisan migrate

```

Setup a Model
-------------

[](#setup-a-model)

```
use Jawadabbass\Friendships\Traits\Friendable;
class User extends Model
{
    use Friendable;
    ...
}
```

How to use
----------

[](#how-to-use)

[Check the Test file to see the package in action](https://github.com/jawadabbass/laravel-friendships/blob/master/tests/FriendshipsTest.php)

#### Send a Friend Request

[](#send-a-friend-request)

```
$user->befriend($recipient);
```

#### Accept a Friend Request

[](#accept-a-friend-request)

```
$user->acceptFriendRequest($sender);
```

#### Deny a Friend Request

[](#deny-a-friend-request)

```
$user->denyFriendRequest($sender);
```

#### Remove Friend

[](#remove-friend)

```
$user->unfriend($friend);
```

#### Block a Model

[](#block-a-model)

```
$user->blockFriend($friend);
```

#### Unblock a Model

[](#unblock-a-model)

```
$user->unblockFriend($friend);
```

#### Check if Model is Friend with another Model

[](#check-if-model-is-friend-with-another-model)

```
$user->isFriendWith($friend);
```

#### Check if Model has a pending friend request from another Model

[](#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

[](#check-if-model-has-already-sent-a-friend-request-to-another-model)

```
$user->hasSentFriendRequestTo($recipient);
```

#### Check if Model has blocked another Model

[](#check-if-model-has-blocked-another-model)

```
$user->hasBlocked($friend);
```

#### Check if Model is blocked by another Model

[](#check-if-model-is-blocked-by-another-model)

```
$user->isBlockedBy($friend);
```

#### Get a single friendship

[](#get-a-single-friendship)

```
$user->getFriendship($friend);
```

#### Get a list of all Friendships

[](#get-a-list-of-all-friendships)

```
$user->getAllFriendships();
```

#### Get a list of pending Friendships

[](#get-a-list-of-pending-friendships)

```
$user->getPendingFriendships();
```

#### Get a list of accepted Friendships

[](#get-a-list-of-accepted-friendships)

```
$user->getAcceptedFriendships();
```

#### Get a list of denied Friendships

[](#get-a-list-of-denied-friendships)

```
$user->getDeniedFriendships();
```

#### Get a list of blocked Friendships

[](#get-a-list-of-blocked-friendships)

```
$user->getBlockedFriendships();
```

#### Get a list of pending Friend Requests

[](#get-a-list-of-pending-friend-requests)

```
$user->getFriendRequests();
```

#### Get the number of Friends

[](#get-the-number-of-friends)

```
$user->getFriendsCount();
```

#### Get the number of Pendings

[](#get-the-number-of-pendings)

```
$user->getPendingsCount();
```

#### Get the number of mutual Friends with another user

[](#get-the-number-of-mutual-friends-with-another-user)

```
$user->getMutualFriendsCount($otherUser);
```

Friends
-------

[](#friends)

To get a collection of friend models (ex. User) use the following methods:

#### Get Friends

[](#get-friends)

```
$user->getFriends();
```

#### Get Friends Paginated

[](#get-friends-paginated)

```
$user->getFriends($perPage = 20);
```

#### Get Friends of Friends

[](#get-friends-of-friends)

```
$user->getFriendsOfFriends($perPage = 20);
```

#### Collection of Friends in specific group paginated:

[](#collection-of-friends-in-specific-group-paginated)

```
$user->getFriends($perPage = 20, $group_name);
```

#### Get mutual Friends with another user

[](#get-mutual-friends-with-another-user)

```
$user->getMutualFriends($otherUser, $perPage = 20);
```

#### Get friends using advanced paginated and scoped status

[](#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
-------------

[](#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

[](#group-a-friend)

```
$user->groupFriend($friend, $group_name);
```

#### Remove a Friend from family group

[](#remove-a-friend-from-family-group)

```
$user->ungroupFriend($friend, 'family');
```

#### Remove a Friend from all groups

[](#remove-a-friend-from-all-groups)

```
$user->ungroupFriend($friend);
```

#### Get the number of Friends in specific group

[](#get-the-number-of-friends-in-specific-group)

```
$user->getFriendsCount($group_name);
```

### To filter `friendships` by group you can pass a group slug.

[](#to-filter-friendships-by-group-you-can-pass-a-group-slug)

```
$user->getAllFriendships($group_name);
$user->getAcceptedFriendships($group_name);
$user->getPendingFriendships($group_name);
...
```

Events
------

[](#events)

This is the list of the events fired by default for each action

Event nameFiredJawadabbass\\Friendships\\Events\\SentWhen a friend request is sentJawadabbass\\Friendships\\Events\\AcceptedWhen a friend request is acceptedJawadabbass\\Friendships\\Events\\DeniedWhen a friend request is deniedJawadabbass\\Friendships\\Events\\BlockedWhen a friend is blockedJawadabbass\\Friendships\\Events\\UnblockedWhen a friend is unblockedJawadabbass\\Friendships\\Events\\CancelledWhen a friendship is cancelledContributing
------------

[](#contributing)

See the [CONTRIBUTING](CONTRIBUTING.md) guide.

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity27

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/eaaeccc922abb6106d9b694d4322c284ed0c13b7de5d934d8ce7bab56086b224?d=identicon)[jawadabbass](/maintainers/jawadabbass)

---

Top Contributors

[![jawadabbass](https://avatars.githubusercontent.com/u/359515?v=4)](https://github.com/jawadabbass "jawadabbass (15 commits)")

### Embed Badge

![Health badge](/badges/jawadabbass-laravel-friendships/health.svg)

```
[![Health](https://phpackages.com/badges/jawadabbass-laravel-friendships/health.svg)](https://phpackages.com/packages/jawadabbass-laravel-friendships)
```

###  Alternatives

[jacksleight/statamic-bard-mutator

26110.1k2](/packages/jacksleight-statamic-bard-mutator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)