README

这是从hootlex/laravel-friendships分支出来的，用于添加对Laravel 8+的支持并扩展其功能。

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

模型可以

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

安装

首先，通过Composer安装此包。

composer require devkhris/laravel-friendships

如果您使用的是Laravel < 5.5，您需要在config/app.php的提供者数组中添加DevKhris\Friendships\FriendshipsServiceProvider

DevKhris\Friendships\FriendshipsServiceProvider::class,

发布配置和迁移

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

在以下位置配置已发布的配置

config\friendships.php

最后，迁移数据库

php artisan migrate

设置模型

use DevKhris\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->getPendingFriendshipsDetails($group_name, $paginate);

获取已接受友谊关系的列表

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

好友分组

好友分组在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);
$user->getPendingFriendshipsDetails($group_name, $paginate);
...

事件

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

贡献

查看CONTRIBUTING指南。

devkhris / laravel-friendships

维护者

详细信息