README

LiveChat 是一个基于 Laravel 的实时用户对话（聊天）系统。您可以轻松地将此包集成到任何基于 Laravel 的项目中。它可以帮助您在几分钟内开发消息系统。以下是 LiveChat 开发的项目截图。

LiveChat v1.0.0 支持实时消息

那么，让我们开始您的探索之旅吧 :)

功能

• 面对面消息
• 实时消息
• 创建新对话
• 显示最新消息的消息线程
• 通过用户 ID 或对话 ID 查看对话
• 支持消息和线程的分页
• 从两端删除（软删除）消息。发送者和接收者都可以从自己的端删除消息
• 永久删除消息
• 标记消息为已读
• 只有参与者可以查看或访问其消息或消息线程
• 使用 oembed 规范进行内联 URL 渲染

安装

LiveChat 是一个 Laravel 包，您可以通过 Composer 安装它。在您的项目目录中从终端运行此命令

composer require jubaer/livechat

请稍等片刻，Composer 将自动在您的项目中安装 LiveChat。

配置

下载完成后，您必须在 config/app.php 配置文件中调用此包服务。为此，在 app.php 中的 providers 部分添加此行

Jubaer\LiveChat\TalkServiceProvider::class,

要使用外观，您必须在 app.php 中的 aliases 数组中添加此行

'Talk'      => Jubaer\LiveChat\Facades\Talk::class,

现在在您的终端中运行此命令以发布此包资源

php artisan vendor:publish --provider="Jubaer\LiveChat\TalkServiceProvider"

运行此命令后，所有必要的文件都将包含在您的项目中。此包有两个默认迁移。因此，您必须运行类似这样的迁移命令。（但请确保您的数据库配置已正确设置。）

php artisan migrate

好的，现在您需要为 Talk 配置您的用户模型。转到 config/talk.php 并进行配置

return [
    'user' => [
        'model' => 'App\User',
        'foreignKey' => null,
        'ownerKey' => null,
    ],

    'broadcast' => [
        'enable' => true,
        'app_name' => 'talk-example',
        'driver' => env('TALK_BROADCAST_DRIVER', 'pusher'), // pusher or laravel-websockets
        'pusher' => [
            'app_id' => env('PUSHER_APP_ID', ''),
            'app_key' => env('PUSHER_APP_KEY', ''),
            'app_secret' => env('PUSHER_APP_SECRET', ''),
            'options' => [
                'cluster' => env('PUSHER_APP_CLUSTER', 'ap2'),
                'encrypted' => env('PUSHER_APP_ENCRYPTION', false),
                'host' => '127.0.0.1',
                'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'scheme' => 'http',
                'wsHost' => '127.0.0.1',
                'wsPort' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'forceTLS' => false,
                'disableStats' => true
            ]
        ],
    ],


    'oembed' => [
        'enabled' => false,
        'url' => '',
        'key' => ''
    ]
];

用法

它非常容易使用。如果您想全局设置认证用户 ID，则必须首先设置一个中间件。转到 app/Http/Kernel.php 并在 $routeMiddleware 数组中设置它

'talk'  =>  \Jubaer\LiveChat\Middleware\TalkMiddleware::class,

现在您可以从任何地方通过中间件使用它。假设您有一个控制器，并且您想在全局设置认证用户 ID，则在控制器构造函数中编写此内容

$this->middleware('talk');

但您可以从控制器中的任何方法使用这些程序

Talk::setAuthUserId(auth()->user()->id);

现在您可以使用您需要的任何方法。但如果您想立即传递认证 ID，此方法可能很有帮助

Talk::user(auth()->user()->id)->anyMethodHere();

请参阅 API 文档。

API 列表

• setAuthUserId
• user
• isConversationExists
• isAuthenticUser
• sendMessage
• sendMessageByUserId
• getInbox
• getInboxAll
• threads
• threadsAll
• getConversationsById
• getConversationsAllById
• getConversationsByUserId
• getConversationsAllByUserId
• getMessages
• getMessagesByUserId
• getMessagesAll
• getMessagesAllByUserId
• readMessage
• makeSeen
• getReceiverInfo
• deleteMessage
• deleteForever
• deleteConversations

setAuthUserId

setAuthUserId 方法设置当前登录用户 ID，您通过参数传递。如果传递 null 或 empty 值，则返回 false。

语法

void setAuthUserId($userid)

示例

控制器构造函数是编写此方法的最佳位置。

function __construct()
{
    Talk::setAuthUserId(auth()->user()->id);
}

当您传递已登录的用户 ID 时，Talk 将知道当前谁为此系统进行了认证。因此，Talk 根据此用户检索所有信息。

user

您可以使用此方法代替 setAuthUserId() 方法。当您需要立即访问用户会话时，可以使用它。语法

object user($id)

示例 当您尚未全局设置认证用户ID时，可以直接与其他方法一起使用此方法。

$inboxes = Talk::user(auth()->user()->id)->threads();
return view('messages.threads', compact('inboxes'));

isConversationExists

此方法检查当前登录用户，并检查给定用户是否已经在会话中

语法

int|false isConversationExists($userid)

示例

if ($conversationId = Talk::isConversationExists($userId)) {
    Talk::sendMessage($conversationId, $message);
}

isAuthenticUser

isAuthenticUser 检查给定用户是否存在于给定会话中。

语法

boolean isAuthenticUser($conversationId, $userId)

示例

if (Talk::isAuthenticUser($conversationId, $userId)) {
    Talk::sendMessage($conversationId, $message);
}

sendMessage

您可以通过使用此方法通过会话ID发送消息。如果消息成功发送，它将返回消息模型的对象，否则，它将返回 false

语法

object|false sendMessage($conversationId, $message)

示例

    $message = Talk::sendMessage($conversationId, $message);
    if ($message) {
        return response()->json(['status'=>'success', 'data'=>$message], 200);
   }

sendMessageByUserId

您可以通过使用此方法通过接收者ID发送消息。如果消息成功发送，它将返回消息模型的对象，否则，它将返回 false

语法

object|false sendMessageByUserId($userId, $message)

getInbox

如果您想获取所有非软删除的收件箱，此方法可能会有所帮助。此方法通过先前分配的认证用户ID获取所有收件箱。它返回包含最新消息的消息线程集合。

语法

array getInbox([$order = 'desc'[,$offset = 0[, $take = 20]]])

示例

// controller method
$inboxes = Talk::getInbox();
return view('message.threads', compact('inboxes'));

<!-- messages/threads.blade.php -->
<ul>
  @foreach($inboxes as $inbox)
  <li>
    <h2>{{$inbox->withUser->name}}</h2>
    <p>{{$inbox->thread->message}}</p>
    <span>{{$inbox->thread->humans_time}}</span>
  </li>
  @endforeach
</ul>

getInboxAll

与 getInbox() 方法类似。如果您想获取包含软删除消息的所有收件箱，此方法可能会有所帮助。此方法通过给定用户ID获取所有收件箱。

语法

object getInboxAll([$order = 'desc'[,$offset = 0[, $take = 20]]])

threads

此方法是 getInbox() 方法的别名。

语法

array threads([$order = 'desc'[,$offset = 0[, $take = 20]]])

threadsAll

此方法是 getInboxAll() 方法的别名。

语法

array threadsAll([$order = 'desc'[,$offset = 0[, $take = 20]]])

getConversationsById

当您想通过您选择的会话ID获取所有会话时，您可以尝试此方法。此方法返回所有（除了软删除）包含 sender 和 withUser 对象的会话

语法

array getConversationsById($conversationId[, $offset = 0[, $take = 20]])

示例

// controller method
$conversations = Talk::getConversationsById($conversationId);
$messages = $conversations->messages;
$withUser = $conversations->withUser;

return view('messages.conversations', compact('messages', 'withUser'));

此方法返回两个对象 messages 和 withUser。其中 messages 对象包含消息集合，而 withUser 对象包含参与者用户集合。

让我们看看如何在视图中使用它

<!-- messages/conversations.blade.php -->
<div class="message-container">
  <h2>Chat with {{$withUser->name}}</h2>
  @foreach ($messages as $msg)
  <div class="message">
    <h4>{{$msg->sender->name}}</h4>
    <span>{{$msg->humans_time}}</span>
    <p>{{$msg->message}}</p>
  </div>
  @endforeach
</div>

getConversationsAllById

此方法与 getConversationsById() 方法类似。这两个方法之间的唯一区别是它返回所有包含软删除条目的消息。

语法

array getConversationsAllById($conversationId[, $offset = 0[, $take = 20]])

getConversationsByUserId

当您想通过您选择的接收者ID获取所有会话时，您可以尝试此方法。此方法返回所有（除了软删除消息）包含用户对象的会话

语法

object getConversationsByUserId($receiverId [, $offset = 0[, $take = 20]])

getConversationsAllByUserId

此方法与 getConversationsByUserId() 方法类似。这两个方法之间的唯一区别是它返回所有包含软删除条目的消息。

语法

array getConversationsAllByUserId($receiverId[, $offset = 0[, $take = 20]])

getMessages

这是 getConversationsById() 方法的别名。

语法

array messages($conversationId[, $offset = 0[, $take = 20]])

getMessagesAll

这是 getConversationsAllById() 方法的别名。

语法

array messagesAll($conversationId[, $offset = 0[, $take = 20]])

getMessagesByUserId

这是 getConversationsByUserId() 方法的别名。

语法

array messagesByUserId($receiverId[, $offset = 0[, $take = 20]])

getMessagesAllByUserId

这是 getConversationsAllByUserId() 方法的别名。

语法

array messagesAllByUserId($receiverId[, $offset = 0[, $take = 20]])

readMessage

如果您想读取一条单独的消息，可以使用它。此方法通过消息ID返回一个单独的消息对象。

语法

array readMessage($messageId)

getReceiverInfo

此方法返回关于消息接收者的所有信息。

此方法从版本 2.0.0 开始已弃用，并将从版本 2.0.2 中删除。

语法

object getReceiverInfo($conversationId)

makeSeen

如果您想将消息标记为已读，可以使用此方法。

语法

boolean makeSeen($messageId)

deleteMessage

当您想从会话中删除特定消息时，您必须使用此方法。此方法对用户端单独软删除消息。

语法

boolean deleteMessage($messageId)

deleteForever

如果您想硬删除或永久删除特定消息，则必须使用此方法。

语法

boolean deleteForever($messageId)

deleteConversations

此方法用于永久删除所有会话。

语法

boolean deleteConversations($conversationId)

实时消息

LiveChat 还支持实时消息。LiveChat 支持 pusher 和 laravel-websocket 进行实时消息。因此，首先您必须配置 pusher 或 laravel-websocket。再次前往 app/talk.php 进行配置。

return [
    'user' => [
        'model' => 'App\User',
        'foreignKey' => null,
        'ownerKey' => null,
    ],

    'broadcast' => [
        'enable' => true,
        'app_name' => 'talk-example',
        'driver' => env('TALK_BROADCAST_DRIVER', 'pusher'), // pusher or laravel-websockets
        'pusher' => [
            'app_id' => env('PUSHER_APP_ID', ''),
            'app_key' => env('PUSHER_APP_KEY', ''),
            'app_secret' => env('PUSHER_APP_SECRET', ''),
            'options' => [
                'cluster' => env('PUSHER_APP_CLUSTER', 'ap2'),
                'encrypted' => env('PUSHER_APP_ENCRYPTION', false),
                'host' => '127.0.0.1',
                'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'scheme' => 'http',
                'wsHost' => '127.0.0.1',
                'wsPort' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'forceTLS' => false,
                'disableStats' => true
            ]
        ],
    ],


    'oembed' => [
        'enabled' => false,
        'url' => '',
        'key' => ''
    ]
];

在这个新版本中，添加了带有谈话配置的广播部分。默认情况下，广播是禁用的。如果您想启用实时（实时）消息，则必须首先启用它。然后，将推流凭证添加到您的 .env 文件中，并在 .env 文件中添加一个名为 PUSHER_APP_NAME 的新行来指定您的应用程序推流名称。就是这样。每次发送消息时，Talk 都会自动触发两个事件，一个用于特定用户，另一个用于特定对话。因此，您可以根据需要监听或订阅一个或两个。最后，您必须使用 talk_live() 辅助函数订阅这些事件。转到您想要订阅以处理消息数据的位置，按照以下代码进行。

<script>
    var msgshow = function(data) {
        // write what you want with this data

        console.log(data);
    }
</script>

{!! talk_live(['user'=>["id"=>auth()->user()->id, 'callback'=>['msgshow']]]) !!}

talk_live() 支持一个参数，即数组。第一个参数是要订阅的频道名称。您不知道哪个频道正在广播。Talk 默认广播两个频道，一个用于用户，另一个用于对话。如果您想订阅当前登录用户的频道，则必须传递

登录用户 ID 在 'user' 键中。 ['user'=>['id'=>auth()->user()->id, 'callback'=>[]] 或者您想订阅对话 ID，您必须传递对话 ID 作为 'conversation' 键。 ['conversation'=>['id'=>$conversationID, 'callback'=>[]]。如果您想同时传递两者。

您可以传递一个回调来处理接收到的推流数据。对于 user 和 conversation 部分都支持回调作为数组。因此，您可以将多个回调作为数组值传递，如前例所示。

您可以观看 Talk-Live-Demo

嵌入支持

Talk 还支持嵌入 URL，只需在您的视图中使用 $message->toHtmlString() 来渲染嵌入链接

例如：这是一个 YouTube 嵌入链接：https://www.youtube.com/watch?v=jNQXAC9IVRw

<div class="message-container">
  <h2>Chat with {{$withUser->name}}</h2>
  @foreach ($messages as $msg)
  <div class="message">
    <h4>{{$msg->sender->name}}</h4>
    <span>{{$msg->humans_time}}</span>
    <p>{{$msg->toHtmlString()}}</p>
  </div>
  @endforeach
</div>

自定义嵌入链接

如果您想设置自己的 oembed 实现，您可以在 talk 配置文件中进行配置。您的端点应遵循 Oembed 规范

    'user' => [
        ...
    ],
    ...
    ],
    'oembed' => [
        'enabled' => true,
        'url' => 'http://your.domain/api/oembed',
        'key' => 'yout-auth-api-key'
    ]

测试

Talk 与 php 5.5 兼容。使用 docker 运行单元测试。

docker-compose run php55 composer install
docker-compose run php55 phpunit

docker-compose run php56 composer install
docker-compose run php56 phpunit

docker-compose run php7 composer install
docker-compose run php7 phpunit

docker-compose run hhvm composer install
docker-compose run hhvm phpunit

此包扩展了 nahid/talk 的版本