README

介绍

PushRadar是一个用于网络的实时API服务。该服务使用简单的发布-订阅模型，允许你在被一个或多个客户端订阅的“频道”上广播“消息”。消息将实时推送到这些客户端。

这是PushRadar的官方PHP库。

先决条件

为了使用此库，请确保您有以下内容

PHP 5.3.3或更高版本。
一个PushRadar账户 - 您可以在www.pushradar.com注册。

Composer

最简单的方法是使用Composer安装库。在您的控制台中运行以下命令

composer require pushradar/pushradar-php

要开始使用此库，创建一个index.php文件，从/vendor文件夹加载Composer的自动加载器

require_once('vendor/autoload.php');

手动安装

或者，如果您不想使用Composer，您可以下载最新版本，并使用require_once在代码中包含init.php文件

require_once('path/to/pushradar-php/init.php');

依赖

为了使用此库，请确保您已启用以下PHP扩展

如果您正在使用Composer，它将自动检查您的系统上是否启用了这些扩展。

入门

"Hello World!"示例

$radar = new \PushRadar\PushRadar("your-secret-key");
$radar->broadcast("test-channel", array("message" => "Hello World!"));

接收消息

要订阅频道并接收它们上广播的消息，请查看PushRadar的JavaScript客户端库的文档。

私有频道

私有频道在订阅者可以接收它们上的消息之前需要先进行身份验证。

为了生成频道身份验证令牌，PushRadar提供了一个方便的channelAuth方法，您可以从身份验证端点调用此方法

return response(json_encode(array("authToken" => $radar->channelAuth("channel-name"))));

请注意，私有频道必须以前缀'private-'开头。

加密频道

PushRadar支持端到端加密的频道。加密频道名称必须以前缀'private-encrypted-'开头，并且与私有频道一样，加密频道需要身份验证。

您的身份验证端点应该返回一个解密密钥，以及如下的身份验证令牌

$radar->setEncryptionMasterKey("secret-master-passphrase");

return response(json_encode(array("authToken" => $radar->channelAuth("channel-name"), "decryptionKey" => $radar->generateDecryptionKey("channel-name"))));

您使用的秘密主密码应该长且难以猜测。至少32个字符。

文档

PushRadar的PHP库的完整文档可以在以下地址找到： www.pushradar.com/docs/php。

pushradar / pushradar-php

维护者

详细信息