README

聊天

为您的多个模型创建聊天应用

想知道如何制作类似这样的包吗？ https://leanpub.com/laravel-package-development

目录

检查一个简单的 演示应用程序

简介

此包允许您将聊天系统添加到您的 Laravel ^5.4 应用程序中

安装

在命令行中运行

composer require musonza/chat

发布资产

php artisan vendor:publish

这将发布数据库迁移和一个配置文件 musonza_chat.php 在 Laravel 配置文件夹中。

配置

参见 musonza_chat.php 进行配置

运行迁移

php artisan migrate

使用

您可以混合模型作为参与者。例如，您可以拥有 Parents、Students 和 Professors 模型进行通信

为模型添加参与能力

将 Musonza\Chat\Traits\Messageable 特性添加到任何您想要参与对话的模型中。例如，让我们假设我们想要我们的 Bot 模型与其他模型聊天

use Illuminate\Database\Eloquent\Model;
use Musonza\Chat\Traits\Messageable;

class Bot extends Model
{
    use Messageable;
}

获取参与者详细信息

由于我们允许结构不同的模型聊天，我们可能希望以统一的方式以统一的方式表示参与者详细信息。

您可以按以下方式获取详细信息

$participantModel->getParticipantDetails();

假设您有一个名为 name 的列，这将返回默认数组 ['name' => 'column_value']。然而，您可以通过向模型添加 Eloquent 访问器来根据您的需求自定义此功能，如下所示

    public function getParticipantDetailsAttribute()
    {
        return [
            'name' => $this->someValue,
            'foo' => 'bar',
        ];
    }

创建对话

您可以通过传递模型数组作为参与者来开始对话

$participants = [$model1, $model2,..., $modelN];

$conversation = Chat::createConversation($participants);

创建私人/公共类型的对话

您可能希望将对话分类为私人或公共

$participants = [$model1, $model2,..., $modelN];

// Create a private conversation
$conversation = Chat::createConversation($participants)->makePrivate();

// Create a public conversation
$conversation = Chat::createConversation($participants)->makePrivate(false);

// Create a direct message

// Make direct conversation after creation
$conversation = Chat::createConversation($participants)->makeDirect();

// Specify intent for direct conversation before creation
$conversation = Chat::makeDirect()->createConversation($participants);

注意：您无法向直接对话添加更多参与者。此外，您不能从直接对话中移除参与者。

通过 ID 获取对话

$conversation = Chat::conversations()->getById($id);

更新对话详细信息

$data = ['title' => 'PHP Channel', 'description' => 'PHP Channel Description'];
$conversation->update(['data' => $data]);

发送文本消息

$message = Chat::message('Hello')
            ->from($model)
            ->to($conversation)
            ->send();

发送自定义类型的消息

默认消息类型是 text。如果您想指定自定义类型，可以调用以下 type() 函数

$message = Chat::message('http://example.com/img')
		->type('image')
		->from($model)
		->to($conversation)
		->send();

添加更多关于消息的详细信息

有时您可能想要添加有关消息的详细信息。例如，当消息类型是附件时，并且您想添加有关附件的文件名和文件 URL 的详细信息时，您可以调用 data() 函数并将数据作为数组传递。

$message = Chat::message('Attachment 1')
		->type('attachment')
		->data(['file_name' => 'post_image.jpg', 'file_url' => 'http://example.com/post_img.jpg'])
		->from($model)
		->to($conversation)
		->send();

通过 ID 获取消息

$message = Chat::messages()->getById($id);

获取消息发送者

$sendModel = $message->sender;

标记消息为已读

Chat::message($message)->setParticipant($participantModel)->markRead();

标记/标记消息

Chat::message($message)->setParticipant($participantModel)->toggleFlag();

Chat::message($message)->setParticipant($participantModel)->flagged(); // true

标记整个对话为已读

Chat::conversation($conversation)->setParticipant($participantModel)->readAll();

未读消息计数

$unreadCount = Chat::messages()->setParticipant($participantModel)->unreadCount();

每个对话的未读消息计数

Chat::conversation($conversation)->setParticipant($participantModel)->unreadCount();

删除消息

Chat::message($message)->setParticipant($participantModel)->delete();

清理已删除的消息

当所有参与者都删除了 $message 或 $conversation 时，要清理什么？

监听 \Musonza\Chat\Eventing\AllParticipantsDeletedMessage 事件，以及

\Musonza\Chat\Eventing\AllParticipantsClearedConversation

清除对话

Chat::conversation($conversation)->setParticipant($participantModel)->clear();

获取参与者的对话

Chat::conversations()->setPaginationParams(['sorting' => 'desc'])
	->setParticipant($participantModel)
	->limit(1)
	->page(1)
	->get();

获取两个参与者之间的对话

$conversation = Chat::conversations()->between($participantModel1, $participantModel2);

获取参与者之间的共同对话

$conversations = Chat::conversations()->common($participants);

$participants 是一个包含参与者模型的数组

从对话中移除参与者

/* removing one user */
Chat::conversation($conversation)->removeParticipants([$participantModel]);

/* removing multiple participants */
Chat::conversation($conversation)->removeParticipants([$participantModel, $participantModel2,...,$participantModelN]);

向对话中添加参与者

/* add one user */
Chat::conversation($conversation)->addParticipants([$participantModel]);

/* add multiple participants */
Chat::conversation($conversation)->addParticipants([$participantModel, $participantModel2]);

获取对话中的消息

Chat::conversation($conversation)->setParticipant($participantModel)->getMessages()

按类型获取用户对话

// private conversations
$conversations = Chat::conversations()->setParticipant($participantModel)->isPrivate()->get();

// public conversations
$conversations = Chat::conversations()->setParticipant($participantModel)->isPrivate(false)->get();

// direct conversations / messages
$conversations = Chat::conversations()->setParticipant($participantModel)->isDirect()->get();

// all conversations
$conversations = Chat::conversations()->setParticipant($participantModel)->get();

获取最近的消息

$messages = Chat::conversations()->setParticipant($participantModel)->limit(25)->page(1)->get();

分页

您可以通过几种方式实现分页。您可以使用相应的函数或如下方式指定 limit 和 page：

   $paginated = Chat::conversations()->setParticipant($participant)
            ->setPaginationParams([
                'page' => 3,
                'perPage' => 10,
                'sorting' => "desc",
                'columns' => [
                    '*'
                ],
                'pageName' => 'test'
            ])
            ->get();

您不必指定所有参数。如果您省略参数，将使用默认值。上面的 $paginated 将返回 Illuminate\Pagination\LengthAwarePaginator。要获取 conversations，只需调用 $paginated->items()

获取对话中的参与者

$participants = $conversation->getParticipants();

获取模型在对话中的参与条目

Chat::conversation($conversation)->getParticipation($model);

更新参与设置

为参与者设置对话设置（例如：mute_mentions, mute_conversation）

$settings = ['mute_mentions' => true];

Chat::conversation($conversation)
    ->getParticipation($this->alpha)
    ->update(['settings' => $settings]);

数据转换器

需要更细粒度地控制从包路由返回的数据？您可以指定自己的模型转换器并利用 Fractal。

您只需在配置文件 musonza_chat.php 中指定转换器的位置，如下所示

/**
 * Model Transformers
 */
'transformers' => [
    'conversation' => \MyApp\Transformers\ConversationTransformer::class,
    'message' => \MyApp\Transformers\MessageTransformer::class,
    'participant' => \MyApp\Transformers\ParticipantTransformer::class,
]

注意： 这仅适用于包路由的响应。

许可证

聊天软件是开源软件，采用 MIT 许可证 许可