README

实时Web应用是未来。《Broadcastt》提供工具帮助开发者创建实时应用。Broadcastt。

PHP HTTP库

请注意，此库仍在beta版，尚未达到第一个重大版本。

语义版本化2.0.0

主要版本零（0.y.z）用于初始开发。任何内容都可能随时更改。公共API不应被视为稳定。

此库与PHP 7.1+兼容

这是一个用于与Broadcastt API交互的PHP库。如果您正在寻找客户端库或不同的服务器库，请查看我们的库列表。

有关教程和更深入的文档，请访问官方网站。

文档

• 第一步
• 配置
• 修饰符
• 辅助工具
• 使用
• 贡献

第一步

使用Composer安装此包

composer require broadcastt/broadcastt-php-http

配置

$appId = 'YOUR_APP_ID';
$appKey = 'YOUR_APP_KEY';
$appSecret = 'YOUR_APP_SECRET';
$appCluster = 'YOUR_APP_CLUSTER';

$client = new Broadcastt\BroadcasttClient( $appId, $appKey, $appSecret, $appCluster );
// or
$client = Broadcastt\BroadcasttClient::fromUri("http://{$appKey}:{$appSecret}@{$appCluster}.broadcastt.xyz/apps/{$appId}");

appId (整数)

应用ID

appKey (字符串)

应用密钥

appSecret (字符串)

应用密钥

appCluster (字符串) 可选

应用集群

默认值: eu

修饰符

scheme (字符串)

例如，http或https

默认值: http

host (字符串)

主机，例如，cluster.broadcastt.xyz。不允许有尾随正斜杠

默认值: eu.broadcasttapp.xyz 如果在初始化期间未设置集群

port (字符串)

HTTP端口

默认值: 80

basePath (字符串)

请求将调用的路径的基础。可以使用{appId}在基础路径中自动解析应用ID。

默认值: /apps/{appId}

timeout (字符串)

HTTP超时

默认值: 30

guzzleClient (混合数组)

用于发送HTTP请求的Guzzle客户端

如果没有设置，则会在第一次请求时初始化，没有任何参数

辅助工具

fromUri($uri)

从给定的URI实例化一个新的客户端。

这些是帮助您修改实例的方法

useCluster($cluster)

修改给定cluster的host值

encrypted()

将scheme更改为https并将port更改为443的快捷方式

使用

trigger($channels, $name, $data, $socketId = null, $jsonEncoded = false)

通过提供事件名称和有效负载来触发事件。

可选地提供一个socket ID以排除客户端（可能是发送者）。

triggerBatch($batch = [], $encoded = false)

同时触发多个事件。

get($path, $params = [])

使用同步HTTP客户端获取任意REST API资源。

所有请求签名都自动处理。

贡献

欢迎任何愿意帮助使此库“更难、更好、更快、更强”的人。