https://github.com/jpush/jpush-api-php-client
JPush's officially supported PHP client library for accessing JPush APIs. 极光推送官方支持的 PHP 版本服务器端 SDK。
https://github.com/jpush/jpush-api-php-client
Last synced: 8 months ago
JSON representation
JPush's officially supported PHP client library for accessing JPush APIs. 极光推送官方支持的 PHP 版本服务器端 SDK。
- Host: GitHub
- URL: https://github.com/jpush/jpush-api-php-client
- Owner: jpush
- License: mit
- Created: 2013-10-10T09:43:04.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-02-24T08:04:11.000Z (almost 4 years ago)
- Last Synced: 2024-04-04T08:02:31.309Z (almost 2 years ago)
- Language: PHP
- Homepage: https://docs.jiguang.cn
- Size: 719 KB
- Stars: 523
- Watchers: 44
- Forks: 210
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JPush API PHP Client
这是 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 分支的代码](https://github.com/jpush/jpush-api-php-client/tree/v3)。
因为运行 Composer 需要 PHP 5.3.2+ 以上版本，所以其不提供 Composer 支持，
也可以[点击链接](https://github.com/jpush/jpush-api-php-client/releases)下载 v3.4.x 版本源码。
## Installation
#### 使用 Composer 安装
- 执行 `$ php composer.phar install` 或 `$ composer install` 进行安装。
#### 直接下载源码安装
> 直接下载源代码也是一种安装 SDK 的方法，不过因为有版本更新的维护问题，所以这种安装方式**十分不推荐**，但由于种种原因导致无法使用 Composer，所以我们也提供了这种情况下的备选方案。
- 下载源代码包，解压到项目中
- 在项目中引入 autoload：
```php
require 'path_to_sdk/autoload.php';
```
## Usage
- [Init API](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#init-api)
- [Push API](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#push-api)
- [Report API](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#report-api)
- [Device API](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#device-api)
- [Schedule API](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#schedule-api)
- [Exception Handle](https://github.com/jpush/jpush-api-php-client/blob/master/doc/api.md#schedule-api)
- [HTTP/2 Support](https://github.com/jpush/jpush-api-php-client/blob/master/doc/http2.md)
- [Group Push](https://github.com/jpush/jpush-api-php-client/blob/master/doc/grouppush.md)
#### 初始化
```php
use JPush\Client as JPush;
...
...
$client = new JPush($app_key, $master_secret);
...
```
OR
```php
$client = new \JPush\Client($app_key, $master_secret);
```
#### 简单推送
```php
$client->push()
->setPlatform('all')
->addAllAudience()
->setNotificationAlert('Hello, JPush')
->send();
```
#### 异常处理
```php
$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
**注意: 这只是使用样例, 不应该直接用于实际环境中!!**
在下载的中的 [examples](https://github.com/jpush/jpush-api-php-client/tree/master/examples) 文件夹有简单示例代码, 开发者可以参考其中的样例快速了解该库的使用方法。
**简单使用方法**
先填写对应的appKey和masterSecret，可以额外设定Registration_id。
若要运行 push_example.php 中的示例代码：
``` bash
# 假定当前目录为 JPush 源码所在的根目录
$ php examples/push_example.php
```
> 同时也可编辑相关的示例文件，更改参数查看执行效果
## Testing
```bash
# 编辑 tests/bootstrap.php 文件，填入必须的变量值
# OR 设置相应的环境变量
# 运行全部测试用例
$ composer tests
# 运行某一具体测试用例
$ composer tests/JPush/xxTest.php
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jpush/jpush-api-php-client.
## License
The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).