Merge pull request #341 from qiniu/hbw

bug fix and add demo

Author: longbai

README.md

@@ -12,11 +12,11 @@
 
 ## 安装
 
-* 通过composer，这是推荐的方式，可以使用composer.json 声明依赖，或者运行下面的命令。SDK 包已经放到这里 [`qiniu/php-sdk`][install-packagist] 。
+* 推荐使用 `composer` 进行安装。可以使用 composer.json 声明依赖，或者运行下面的命令。SDK 包已经放到这里 [`qiniu/php-sdk`][install-packagist] 。
 ```bash
 $ composer require qiniu/php-sdk
 ```
-* 直接下载安装，SDK 没有依赖其他第三方库，但需要参照 composer的autoloader，增加一个自己的autoloader程序。
+* 直接下载安装，SDK 没有依赖其他第三方库，但需要参照 composer 的 autoloader，增加一个自己的 autoloader 程序。
 
 ## 运行环境
 
@@ -32,10 +32,10 @@ $ composer require qiniu/php-sdk
 use Qiniu\Storage\UploadManager;
 use Qiniu\Auth;
 ...
-    $upManager = new UploadManager();
+    $uploadMgr = new UploadManager();
     $auth = new Auth($accessKey, $secretKey);
-    $token = $auth->uploadToken($bucketName);
-    list($ret, $error) = $upManager->put($token, 'formput', 'hello world');
+    $token = $auth->uploadToken($bucket);
+    list($ret, $error) = $uploadMgr->putFile($token, 'key', 'filePath');
 ...
 ```
 
@@ -47,8 +47,8 @@ $ ./vendor/bin/phpunit tests/Qiniu/Tests/
 
 ## 常见问题
 
-- $error保留了请求响应的信息，失败情况下ret 为none, 将$error可以打印出来，提交给我们。
-- API 的使用 demo 可以参考 [单元测试](https://github.com/qiniu/php-sdk/blob/master/tests)。
+- `$error` 保留了请求响应的信息，失败情况下 `ret` 为 `none`, 将 `$error` 可以打印出来，提交给我们。
+- API 的使用 demo 可以参考 [examples](https://github.com/qiniu/php-sdk/tree/master/examples)。
 
 ## 代码贡献
 
@@ -61,12 +61,12 @@ $ ./vendor/bin/phpunit tests/Qiniu/Tests/
 ## 联系我们
 
 - 如果需要帮助，请提交工单（在portal右侧点击咨询和建议提交工单，或者直接向 [email protected] 发送邮件）
-- 如果有什么问题，可以到问答社区提问，[问答社区](http://qiniu.segmentfault.com/)
-- 更详细的文档，见[官方文档站](http://developer.qiniu.com/)
-- 如果发现了bug， 欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues)
+- 如果有什么问题，可以到问答社区提问，[问答社区](https://qiniu.segmentfault.com/)
+- 更详细的文档，见[官方文档站](https://developer.qiniu.com/)
+- 如果发现了 bug， 欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues)
 - 如果有功能需求，欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues)
 - 如果要提交代码，欢迎提交 pull request
-- 欢迎关注我们的[微信](http://www.qiniu.com/#weixin) [微博](http://weibo.com/qiniutek)，及时获取动态信息。
+- 欢迎关注我们的[微信](https://www.qiniu.com/#weixin) [微博](https://weibo.com/qiniutek)，及时获取动态信息。
 
 ## 代码许可
 

examples/README.md

@@ -1,10 +1,10 @@
 # examples
 
-这些 examples 旨在帮助你快速了解使用七牛的sdk。这些demo都是可以直接运行的， 但是在运行之前需要填上您自己的参数。
+这些 examples 旨在帮助你快速了解使用七牛的 SDK。这些 demo 都是可以直接运行的， 但是在运行之前需要填上您自己的参数。
 
 比如：
 
-* `$bucket`  需要填上您想操作的 [bucket名字](http://developer.qiniu.com/docs/v6/api/overview/concepts.html#bucket)。
-* `$accessKey` 和 `$secretKey` 可以在我们的[管理后台](https://portal.qiniu.com/setting/key)找到。
-* 在进行`视频转码`， `压缩文件`等异步操作时 需要使用到的队列名称也可以在我们[管理后台](https://portal.qiniu.com/mps/pipeline)新建。
+* `$bucket`  需要填上您想操作的 [bucket名字](https://portal.qiniu.com/kodo/bucket)。
+* `$accessKey` 和 `$secretKey` 可以在我们的[管理后台](https://portal.qiniu.com/user/key)找到。
+* 在进行`视频转码`， `压缩文件`等异步操作时 需要使用到的队列名称也可以在我们[管理后台](https://portal.qiniu.com/dora/media-gate/pipeline)新建。
 

examples/bucket_lifecycleRule.php

@@ -2,19 +2,25 @@
 require_once __DIR__ . '/../autoload.php';
 
 use Qiniu\Auth;
+use Qiniu\Config;
+use Qiniu\Storage\BucketManager;
 
+// 控制台获取密钥：https://portal.qiniu.com/user/key
 $accessKey = getenv('QINIU_ACCESS_KEY');
 $secretKey = getenv('QINIU_SECRET_KEY');
 
 $auth = new Auth($accessKey, $secretKey);
-$config = new \Qiniu\Config();
-$bucketManager = new \Qiniu\Storage\BucketManager($auth, $config);
+$config = new Config();
+$bucketManager = new BucketManager($auth, $config);
 
-$bucket = 'xxxx';
-$name = 'demo';
-$prefix = 'test';
-$delete_after_days = 80;
-$to_line_after_days =70;
+// 存储空间 - 新增生命周期规则
+// 参考文档：https://developer.qiniu.com/kodo/manual/3699/life-cycle-management
+
+$bucket = 'xxxx'; // 存储空间名称
+$name = 'demo';   // 生命周期规则名称
+$prefix = 'test'; // 规则策略中的前缀
+$delete_after_days = 80; // 用户新创建的文件将在该设定时间之后自动删除
+$to_line_after_days = 70; // 用户新创建的文件将在该设定的时间之后自动转为低频存储
 
 list($Info, $err) = $bucketManager->bucketLifecycleRule(
     $bucket,

examples/cdn_get_bandwidth.php

@@ -2,29 +2,30 @@
 
 require_once __DIR__ . '/../autoload.php';
 
-use \Qiniu\Cdn\CdnManager;
+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 Qiniu\Auth($accessKey, $secretKey);
+$auth = new Auth($accessKey, $secretKey);
 $cdnManager = new CdnManager($auth);
 
-//获取流量和带宽数据
-//参考文档：http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+// 获取流量和带宽数据
+// 参考文档：https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth
 
 $domains = array(
     "javasdk.qiniudn.com",
     "phpsdk.qiniudn.com"
 );
 
-$startDate = "2017-08-20";
-$endDate = "2017-08-21";
+$startDate = "2020-08-03";
+$endDate = "2020-08-05";
 
-//5min or hour or day
+// 5min or hour or day
 $granularity = "day";
 
-//获取带宽数据
 list($bandwidthData, $getBandwidthErr) = $cdnManager->getBandwidthData(
     $domains,
     $startDate,

examples/cdn_get_flux.php

@@ -2,29 +2,30 @@
 
 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 Qiniu\Auth($accessKey, $secretKey);
+$auth = new Auth($accessKey, $secretKey);
 $cdnManager = new CdnManager($auth);
 
-//获取流量和带宽数据
-//参考文档：http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+// 获取流量和带宽数据
+// 参考文档：https://developer.qiniu.com/fusion/api/1230/traffic-bandwidth
 
 $domains = array(
     "javasdk.qiniudn.com",
     "phpsdk.qiniudn.com"
 );
 
-$startDate = "2017-08-20";
-$endDate = "2017-08-21";
+$startDate = "2020-08-03";
+$endDate = "2020-08-05";
 
 //5min or hour or day
 $granularity = "day";
 
-//获取流量数据
 list($fluxData, $getFluxErr) = $cdnManager->getFluxData($domains, $startDate, $endDate, $granularity);
 if ($getFluxErr != null) {
     var_dump($getFluxErr);

examples/cdn_get_log_list.php

@@ -2,23 +2,25 @@
 
 require_once __DIR__ . '/../autoload.php';
 
-use \Qiniu\Cdn\CdnManager;
+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 Qiniu\Auth($accessKey, $secretKey);
+$auth = new Auth($accessKey, $secretKey);
 $cdnManager = new CdnManager($auth);
 
+// 获取日志下载链接
+// 参考文档：https://developer.qiniu.com/fusion/api/1226/download-the-log
+
 $domains = array(
     "javasdk.qiniudn.com",
     "phpsdk.qiniudn.com"
 );
 
-$logDate = '2017-08-20';
-
-//获取日志下载链接
-//参考文档：http://developer.qiniu.com/article/fusion/api/log.html
+$logDate = '2020-08-05';
 
 list($logListData, $getLogErr) = $cdnManager->getCdnLogList($domains, $logDate);
 if ($getLogErr != null) {

examples/cdn_refresh_urls_dirs.php

@@ -2,29 +2,32 @@
 
 require_once __DIR__ . '/../autoload.php';
 
-use \Qiniu\Cdn\CdnManager;
+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 Qiniu\Auth($accessKey, $secretKey);
+$auth = new Auth($accessKey, $secretKey);
+
+//---------------------------------------- demo1 ----------------------------------------
+// 刷新文件和目录
+// 文件列表一次最多提交 60 个，目录一次最多提交 10 个
+// 参考文档：https://developer.qiniu.com/fusion/api/1229/cache-refresh
 
-//待刷新的文件列表和目录，文件列表最多一次100个，目录最多一次10个
-//参考文档：http://developer.qiniu.com/article/fusion/api/refresh.html
 $urls = array(
     "http://phpsdk.qiniudn.com/qiniu.jpg",
     "http://phpsdk.qiniudn.com/qiniu2.jpg",
 );
 
-//刷新目录需要联系七牛技术支持开通账户权限
 $dirs = array(
     "http://phpsdk.qiniudn.com/test/"
 );
 
 $cdnManager = new CdnManager($auth);
 
-// 目前客户默认没有目录刷新权限，刷新会有400038报错，参考：https://developer.qiniu.com/fusion/api/1229/cache-refresh
-// 需要刷新目录请工单联系技术支持 https://support.qiniu.com/tickets/category
+// 如果刷新返回 400038 报错，则需要联系七牛技术支持开通刷新目录权限，参考：https://developer.qiniu.com/fusion/api/1229/cache-refresh，
 list($refreshResult, $refreshErr) = $cdnManager->refreshUrlsAndDirs($urls, $dirs);
 if ($refreshErr != null) {
     var_dump($refreshErr);
@@ -33,20 +36,24 @@
     print_r($refreshResult);
 }
 
-//如果只有刷新链接或者目录的需求，可以分布使用
+//---------------------------------------- demo2 ----------------------------------------
+// 刷新文件
 
 list($refreshResult, $refreshErr) = $cdnManager->refreshUrls($urls);
 if ($refreshErr != null) {
     var_dump($refreshErr);
 } else {
-    echo "refresh request sent\n";
+    echo "refresh urls request sent\n";
     print_r($refreshResult);
 }
 
+//---------------------------------------- demo3 ----------------------------------------
+// 刷新目录
+
 list($refreshResult, $refreshErr) = $cdnManager->refreshDirs($dirs);
 if ($refreshErr != null) {
     var_dump($refreshErr);
 } else {
-    echo "refresh request sent\n";
+    echo "refresh dirs request sent\n";
     print_r($refreshResult);
 }

examples/cdn_timestamp_antileech.php

@@ -2,17 +2,18 @@
 
 require_once __DIR__ . '/../autoload.php';
 
-use \Qiniu\Cdn\CdnManager;
+use Qiniu\Cdn\CdnManager;
+
+// 创建带时间戳防盗链的 URL
+// 参考文档：https://developer.qiniu.com/fusion/manual/3841/timestamp-hotlinking-prevention-fusion
 
-//创建时间戳防盗链
-//时间戳防盗链密钥，后台获取
 $encryptKey = 'your_domain_timestamp_antileech_encryptkey';
 
-//带访问协议的域名
-$url1 = 'http://phpsdk.qiniuts.com/24.jpg?avinfo';
+// 一定要带访问协议，也就是 http:// 或者 https://
+$url1 = 'http://phpsdk.qiniuts.com/24.jpg?imageInfo';
 $url2 = 'http://phpsdk.qiniuts.com/24.jpg';
 
-//有效期时间（单位秒）
+// 有效期时间（单位秒）
 $durationInSeconds = 3600;
 
 $signedUrl = CdnManager::createTimestampAntiLeechUrl($url1, $encryptKey, $durationInSeconds);

examples/censor_image.php

@@ -0,0 +1,42 @@
+<?php
+
+require_once __DIR__ . '/../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Config;
+use Qiniu\Storage\ArgusManager;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+
+
+$auth = new Auth($accessKey, $secretKey);
+
+$config = new Config();
+$argusManager = new ArgusManager($auth, $config);
+
+// 图片内容审核
+// 参考文档：https://developer.qiniu.com/censor/api/5588/image-censor
+
+$body = '{
+    "data":{
+        "uri":"https://www-static.qbox.me/_next/static/media/pic01.c8b5db2cc5fcb6fc4e6349c9e37c8e6b.png"
+    },
+    "params":{
+        "scenes":[
+            "pulp",
+            "terror",
+            "politician",
+            "ads"
+        ]
+    }
+}';
+
+list($ret, $err) = $argusManager->censorImage($body);
+echo "\n====> Result is: \n";
+if ($err !== null) {
+    var_dump($err);
+} else {
+    var_dump($ret);
+}