websuckit / websuckit-php
Websuckit PHP 库
v1.0.0
2023-11-08 11:23 UTC
Requires
- php: >=8.1
- ext-curl: *
- phpseclib/phpseclib: ^3.0
Requires (Dev)
- mockery/mockery: ^1.6
- pestphp/pest: ^2.24
README
有关 Websuckit Channels 的教程和更多详细信息,请访问我们的 官方文档。
使用概述
以下主题将涵盖
安装
使用 Composer
composer require websuckit/websuckit-php
初始化
require_once 'vendor/autoload.php'; use Websuckit\WebsuckitPhp\Config; use Websuckit\WebsuckitPhp\Websuckit; $config = new Config($_ENV['USER_ID'], $_ENV['ACCESS_KEY'], $_ENV['PUBLIC_KEY']); $websuckit = new Websuckit($config);
您可以从 websuckit 控制台 获取您的 USER_ID
、ACCESS_KEY
和 PUBLIC_KEY
。
通道
访问通道的 WebSocket URL
您可以通过通道名称通过 getConnectionUrl
函数访问通道 WebSocket URL
use Websuckit\WebsuckitPhp\Types\ChannelConnectionUrlConfig; $channel = new ChannelConnectionUrlConfig('CHANNEL-NAME', 'CHANNEL-PASS-KEY', false); $connection_url = $websuckit->getConnectionUrl($channel);
创建通道
$channel = $websuckit->createChannel('new-channel', 2);
获取通道
$channel = $websuckit->getChannel('CHANNEL-NAME');
获取通道列表(分页)
$page = "0"; $per_page = "10"; //search variable that can be null $search = "search-term" $channels = $websuckit->getChannels($page, $per_page, $search);
获取或创建通道
$channel = $websuckit->getOrCreateChannel('CHANNEL-NAME');
更新通道
$channel = $websuckit->updateChannel('CHANNEL-ID', "CHANGE-CHANNEL-NAME", false, 2);
删除通道
$websuckit->deleteChannel('CHANNEL-ID');