README

ChatKit即将关闭 - https://blog.pusher.com/narrowing-our-product-focus

Laravel包装器Pusher Chatkit。更多关于Chatkit的信息请在此处了解。

注意：此包需要Laravel 5.5或更高版本

安装

composer require shalvah/pusher-chatkit-laravel

该包将自动使用Chatkit PHP库的最新稳定版本（目前为1.1.0）。

快速入门

运行以下命令发布配置文件：

php artisan vendor:publish --provider="Chatkit\Laravel\ChatkitServiceProvider"

这将创建一个可在您的应用程序中修改以匹配您配置的config/chatkit.php文件。从Chatkit应用程序仪表板获取您的Chatkit应用程序详情，并按如下方式添加到您的.env文件中：

CHATKIT_INSTANCE_LOCATOR=your-instance-locator
CHATKIT_KEY=your-key

就这样。您可以通过应用程序中的外观使用Chatkit

<?php
use Chatkit\Laravel\Facades\Chatkit;


public function startChatting()
{
    Chatkit::createUser(['id' => 'hc', 'name' => 'Hamilton Chapman']);
    Chatkit::createRoom(['creator_id' => 'hc', 'name' => 'Cat Lovers']);
    Chatkit::sendMessage(['sender_id' => 'hc', 'room_id' => 'r001', 'text' => 'Hi, everyone!' ]);
}

或者，您可以将ChatkitManager注入到您的方法中

<?php
use Chatkit\Laravel\ChatkitManager;

public function startChatting(ChatkitManager $chatkitManager)
{
    $chatkitManager->createUser(['id' => 'hc', 'name' => 'Hamilton Chapman']);
    $chatkitManager->createRoom(['creator_id' => 'hc', 'name' => 'Cat Lovers']);
    $chatkitManager->sendMessage([
        'sender_id' => 'hc', 
        'room_id' => 'r001', 
        'text' => 'Hi, everyone!'
    ]);
}

配置

config/chatkit.php文件允许您配置您的Chatkit使用（例如，使用多个连接）。

使用多个连接

假设您必须与同一服务器上的多个聊天应用程序一起工作。您可以轻松地通过上述方式发布配置文件，然后根据需要配置各种连接。然后，您可以使用外观或Manager类根据需要切换连接。

<?php

// use whatever connection is default -- by default, this is 'main'
Chatkit::createRoom(['creator_id' =>'admin', 'name' => 'Just Chat']);

// use the 'main' connection
Chatkit::connection('main')->createRoom(['creator_id' =>'admin', 'name' => 'Just Chat']);

// use the 'test' connection
Chatkit::connection('test')->createRoom('admin', ['name' => 'Just Chat']);

// use the 'secondary' connection
Chatkit::setDefaultConnection('secondary');
Chatkit::createRoom(['creator_id' =>'admin', 'name' => 'Just Chat']);

文档

可用的方法完整列表可在Chatkit PHP SDK文档中找到。

许可

MIT