Merge pull request #344 from qiniu/hbw

Update demo and add  function

Author: longbai

docs/rtc/README.md

@@ -0,0 +1,40 @@
+<?php
+
+require_once __DIR__ . '/../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Cdn\CdnManager;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+
+$auth = new Auth($accessKey, $secretKey);
+$cdnManager = new CdnManager($auth);
+
+// 查询 CDN 预取记录
+// 参考文档：https://developer.qiniu.com/fusion/api/1227/file-prefetching#4
+
+$requestId = null;     // 指定要查询记录所在的刷新请求id
+$urls = null;              // 要查询的url列表
+$state = 'success';        // 指定要查询记录的状态，取值 processing／success／failure
+$pageNo = 0;               // 要求返回的页号，默认为0
+$pageSize = 100;           // 要求返回的页长度，默认为100
+$startTime = '2020-09-11 12:00:00';     // 指定查询的开始日期，格式2006-01-01
+$endTime = '2020-09-20 21:00:00';       // 指定查询的结束日期，格式2006-01-01
+
+list($ret, $err) = $cdnManager->getCdnPrefetchList(
+    $requestId,
+    $urls,
+    $state,
+    $pageNo,
+    $pageSize,
+    $startTime,
+    $endTime
+);
+echo "\n====> query prefetch list: \n";
+if ($err !== null) {
+    var_dump($err);
+} else {
+    var_dump($ret);
+}

docs/rtc/example.php

@@ -0,0 +1,42 @@
+<?php
+
+require_once __DIR__ . '/../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Cdn\CdnManager;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+
+$auth = new Auth($accessKey, $secretKey);
+$cdnManager = new CdnManager($auth);
+
+// 查询 CDN 刷新记录
+// 参考文档：https://developer.qiniu.com/fusion/api/1229/cache-refresh#4
+
+$requestId = 'xxxxxx';     // 指定要查询记录所在的刷新请求id
+$isDir = 'no';             // 指定是否查询目录，取值为yes/no，默认不填则为两种类型记录都查询
+$urls = array();           // 要查询的url列表，每个url可以是文件url，也可以是目录url
+$state = 'success';        // 指定要查询记录的状态，取值 processing／success／failure
+$pageNo = 0;               // 要求返回的页号，默认为0
+$pageSize = 100;           // 要求返回的页长度，默认为100
+$startTime = '2020-09-11 12:00:00';     // 指定查询的开始日期，格式2006-01-01
+$endTime = '2020-09-20 21:00:00';       // 指定查询的结束日期，格式2006-01-01
+
+list($ret, $err) = $cdnManager->getCdnRefreshList(
+    $requestId,
+    $isDir,
+    $urls,
+    $state,
+    $pageNo,
+    $pageSize,
+    $startTime,
+    $endTime
+);
+echo "\n====> query refresh list: \n";
+if ($err !== null) {
+    var_dump($err);
+} else {
+    var_dump($ret);
+}

docs/sms/example.php

@@ -0,0 +1,34 @@
+# Rtc Streaming Cloud Server-Side Library For PHP
+
+## Features
+
+- RoomToken 签发
+    - [x] 生成 RoomToken: client->appToken() 
+
+- App 管理
+    - [x] 创建应用: client->createApp()
+    - [x] 获取应用配置信息: client->getApp()
+    - [x] 更新应用配置信息: client->updateApp()
+    - [x] 删除应用: client->deleteApp()
+
+- 房间管理
+    - [x] 列举房间下的所有用户: client->listUser()
+    - [x] 指定一个用户踢出房间: client->kickUser()
+    - [x] 停止一个房间的合流转推: client->stopMerge()
+    - [x] 获取当前所有活跃的房间: client->listActiveRooms()
+
+## Demo
+- RoomToken 签发
+    - [生成 RoomToken](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_create_roomToken.php)
+
+- App 管理
+    - [创建应用](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_createApp.php)
+    - [获取应用配置信息](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_getApp.php)
+    - [更新应用配置信息](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_updateApp.php)
+    - [删除应用](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_deleteApp.php)
+
+- 房间管理
+    - [列举房间下的所有用户](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_rooms_listUser.php)
+    - [指定一个用户踢出房间](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_rooms_kickUser.php)
+    - [停止一个房间的合流转推](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_rooms_stopMerge.php)
+    - [获取当前所有活跃的房间](https://github.com/qiniu/php-sdk/tree/master/examples/rtc/rtc_rooms_listActiveRooms.php)   

examples/cdn_get_prefetch_list.php

@@ -0,0 +1,32 @@
+<?php
+require_once __DIR__ . '/../../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Rtc\AppClient;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+
+$auth = new Auth($accessKey, $secretKey);
+$client = new AppClient($auth);
+
+// 绑定的直播hub，使用此hub的资源进行推流等业务功能，hub与app必须属于同一个七牛账户
+$hub = 'rtchub';
+
+// app 的名称，注意：Title 不是唯一标识，重复 create 动作将生成多个 app
+$title = 'rtc';
+
+// 连麦房间支持的最大在线人数
+$maxUsers = 20;
+
+// 创建应用
+// 参考文档：https://doc.qnsdk.com/rtn/docs/server_overview#2_1
+
+list($ret, $err)  = $client->createApp($hub, $title, $maxUsers);
+if ($err !== null) {
+    var_dump($err);
+} else {
+    echo "\n====> Create Successfully： \n";
+    var_dump($ret);
+}

examples/cdn_get_refresh_list.php

@@ -0,0 +1,34 @@
+<?php
+require_once __DIR__ . '/../../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Rtc\AppClient;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+
+$auth = new Auth($accessKey, $secretKey);
+$client = new AppClient($auth);
+
+// app 的唯一标识，创建的时候由系统生成
+$appId = 'xxxx';
+
+// 房间名称，需满足规格 ^[a-zA-Z0-9_-]{3,64}$
+$roomName = 'room01';
+
+// 请求加入房间的用户 ID，需满足规格 ^[a-zA-Z0-9_-]{3,50}$
+$userId = '001';
+
+// 鉴权的有效时间，传入以秒为单位的64位 Unix 绝对时间，token 将在该时间后失效
+$expireAt = time()+3600;
+
+// "admin"或"user"，默认为"user" 。当权限角色为"admin"时，拥有将其他用户移除出房间等特权
+$permission = 'admin';
+
+// 生成加入房间的令牌 RoomToken
+// 参考文档：https://doc.qnsdk.com/rtn/docs/server_overview#1
+
+$RoomToken  = $client->appToken($appId, $roomName, $userId, $expireAt, $permission);
+echo "\n====> Create RoomToken Successfully： \n";
+var_dump($RoomToken);