README

这是 JPush REST API 的 PHP 版本封装开发包，由极光推送官方提供，通常支持最新的 API 功能。

对应的 REST API 文档: https://docs.jiguang.cn/jpush/server/push/server_overview/

支持的 PHP 版本: 5.3.3 ～ 5.6.x, 7.x

若需要兼容 PHP 5.3.3 以下版本，可以使用 v3 分支的代码。因为运行 Composer 需要 PHP 5.3.2+ 以上版本，所以不提供 Composer 支持，也可以点击链接下载 v3.4.x 版本源码。

安装

使用 Composer 安装

执行 $ php composer.phar install 或 $ composer install 进行安装。

直接下载源码安装

直接下载源代码也是一种安装 SDK 的方法，但因为有版本更新的维护问题，所以这种安装方式非常不推荐。但由于各种原因导致无法使用 Composer，所以我们也提供了这种情况下的备选方案。

下载源代码包，解压到项目中
在项目中引入 autoload：

require 'path_to_sdk/autoload.php';

使用

初始化

use JPush\Client as JPush;
...
...

    $client = new JPush($app_key, $master_secret);

...

或

$client = new \JPush\Client($app_key, $master_secret);

简单推送

$client->push()
    ->setPlatform('all')
    ->addAllAudience()
    ->setNotificationAlert('Hello, JPush')
    ->send();

异常处理

$pusher = $client->push();
$pusher->setPlatform('all');
$pusher->addAllAudience();
$pusher->setNotificationAlert('Hello, JPush');
try {
    $pusher->send();
} catch (\JPush\Exceptions\JPushException $e) {
    // try something else here
    print $e;
}

示例

注意：这只是一个示例，不应直接用于实际环境！

在下载的 examples 文件夹中有简单示例代码，开发者可以参考其中的样例快速了解该库的使用方法。

简单使用方法

先填写对应的appKey和masterSecret，可以额外设定Registration_id。

若要运行 push_example.php 中的示例代码：

# 假定当前目录为 JPush 源码所在的根目录
$ php examples/push_example.php

也可以编辑相关的示例文件，更改参数查看执行效果

测试

# 编辑 tests/bootstrap.php 文件，填入必须的变量值
# OR 设置相应的环境变量

# 运行全部测试用例
$ composer tests

# 运行某一具体测试用例
$ composer tests/JPush/xxTest.php

贡献

欢迎在 GitHub 上提交错误报告和 pull request：https://github.com/jpush/jpush-api-php-client.

许可协议

该库根据 MIT 许可协议开源。

qcgzxw / jpush

维护者

详细信息