merodiro/friendships

此包为用户提供管理好友关系的能力。

维护者

详细信息

github.com/merodiro/Friendships

源代码

问题

安装数: 9,675

依赖: 0

建议者: 0

安全: 0

星标: 45

关注者: 0

分支: 3

开放问题: 1

v1.2.4 2018-05-16 02:11 UTC

Requires

Requires (Dev)

MIT 91ee0bb0b103abac3cb07ef94fd7ce0414e78c48

  • Amr <merodiro.woop@gmail.com>

laravelfriendsfriendshipseloquentfriend-system

This package is not auto-updated.

Last update: 2024-09-29 02:39:21 UTC

README

Latest Version on Packagist Software License Build Status Build status Coverage Status Quality Score Total Downloads

此包为用户提供管理好友关系的能力。

模型可以

  • 发送好友请求
  • 接受好友请求
  • 拒绝好友请求
  • 删除好友

安装

首先，通过 Composer 安装此包。

composer require merodiro/friendships

然后，在 config/app.php 中包含服务提供者。

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

最后，迁移数据库

php artisan migrate

设置模型

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

如何使用

查看测试文件以查看包的实际操作

发送好友请求

$user->addFriend($recipient);

接受好友请求

$user->acceptFriend($sender);

拒绝好友请求

$user->deleteFriend($sender);

移除好友

$user->deleteFriend($friend);

共同好友

$user->mutualFriends($anotherUser);

检查两个用户之间的当前关系

$user->checkFriendship($anotherUser);

它返回

  • same_user => 如果用户正在检查自己的账户
  • friends => 如果他们是好友
  • waiting => 如果 $user 发送了请求，等待 $anotherUser 的批准
  • pending => 如果 $anotherUser 发送了请求，等待 $user 的批准
  • not_friends => 如果他们不是好友

检查两个用户是否是好友

$user->isFriendsWith($anotherUser);

如果是好友则返回 true，如果不是则返回 false

好友

要获取用户集合，请使用以下方法

获取好友

$user->friends();

获取 $user 收到的好友请求列表

$user->friendRequestsReceived();

获取 $user 发出的好友请求列表

$user->friendRequestsSent();

事件

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

有关如何使用事件的更多信息，请查看此示例

测试

$ composer test

贡献

请参阅 CONTRIBUTING 和 CODE_OF_CONDUCT 以获取详细信息。

安全

如果您发现任何安全问题，请通过电子邮件 merodiro@gmail.com 而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。