README

该软件包为 Eloquent 模型提供了管理其友谊的能力。您可以轻松设计一个类似 Facebook 的友谊系统。

模型可以

发送朋友请求
接受朋友请求
拒绝朋友请求
阻止另一个模型
分组朋友

安装

首先，通过 Composer 安装该软件包。

composer require jawadabbass/laravel-friendships

发布配置和迁移

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

在

config\friendships.php

最后，迁移数据库

php artisan migrate

设置模型

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

如何使用

查看测试文件以查看软件包的实际应用

发送朋友请求

$user->befriend($recipient);

接受朋友请求

$user->acceptFriendRequest($sender);

拒绝朋友请求

$user->denyFriendRequest($sender);

删除朋友

$user->unfriend($friend);

阻止模型

$user->blockFriend($friend);

解除模型阻止

$user->unblockFriend($friend);

检查模型是否与另一个模型是朋友

$user->isFriendWith($friend);

检查模型是否收到了另一个模型的待处理朋友请求

$user->hasFriendRequestFrom($sender);

检查模型是否已经向另一个模型发送了朋友请求

$user->hasSentFriendRequestTo($recipient);

检查模型是否阻止了另一个模型

$user->hasBlocked($friend);

检查模型是否被另一个模型阻止

$user->isBlockedBy($friend);

获取单个友谊

$user->getFriendship($friend);

获取所有友谊列表

$user->getAllFriendships();

获取待处理友谊列表

$user->getPendingFriendships();

获取已接受友谊列表

$user->getAcceptedFriendships();

获取已拒绝友谊列表

$user->getDeniedFriendships();

获取已阻止友谊列表

$user->getBlockedFriendships();

获取待处理朋友请求列表

$user->getFriendRequests();

获取朋友数量

$user->getFriendsCount();

获取待处理数量

$user->getPendingsCount();

获取与另一个用户的共同朋友数量

$user->getMutualFriendsCount($otherUser);

朋友

要获取朋友模型（例如用户）的集合，请使用以下方法

获取朋友

$user->getFriends();

获取分页的朋友

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

获取朋友的朋友

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

获取特定组的分页朋友集合

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

获取与另一个用户的共同朋友

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

使用高级分页和作用域状态获取朋友

// 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);

朋友组

朋友组在 config/friendships.php 文件中定义。软件包附带一些默认组。要修改它们或添加自己的，您需要指定一个 slug 和一个 key。

// config/friendships.php
...
'groups' => [
    'acquaintances' => 0,
    'close_friends' => 1,
    'family' => 2
]

由于您已配置了朋友组，您可以使用以下方法来分组/取消分组朋友。

分组一个朋友

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

从家庭组中删除一个朋友

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

从所有组中删除一个朋友

$user->ungroupFriend($friend);

获取特定组中朋友的数量

$user->getFriendsCount($group_name);

要按组过滤 `friendships`，可以传递一个组 slug。

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

事件

这是默认为每个动作触发的事件的列表

贡献

查看 CONTRIBUTING 指南。

jawadabbass / laravel-friendships

维护者

详细信息