README

--

此存储库目前是Demency/laravel-friendships（已被删除）的副本和备份。我计划继续支持此包。

--

此包为Eloquent模型提供了管理好友关系的能力。您可以轻松设计一个类似于Facebook的好友系统。

模型可以

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

安装

首先，通过Composer安装包。

composer require n3rdp1um23/laravel-friendships

发布配置和迁移

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

在

config\friendships.php

最后，迁移数据库

php artisan migrate

设置一个模型

use N3rdP1um23\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），请使用以下方法

获取好友

$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.)
$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);
...

事件

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

贡献

请参阅贡献指南。