Merge pull request #346 from qiniu/hbw

update comment and coding style

Author: longbai

.scrutinizer.yml

@@ -33,3 +33,10 @@ tools:
     php_cpd:
         enabled: true
         excluded_dirs: [vendor, tests]
+build:
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
+

.travis.yml

@@ -20,9 +20,6 @@ script:
   - ./vendor/bin/phpcs --standard=PSR2 tests
   - ./vendor/bin/phpunit --coverage-clover=coverage.xml
 
-after_script:
-  - wget https://scrutinizer-ci.com/ocular.phar
-
 env:
   global:
     - QINIU_ACCESS_KEY=vHg2e7nOh7Jsucv2Azr5FH6omPgX22zoJRWa0FN5

examples/bucket_lifecycleRule.php

@@ -22,15 +22,15 @@
 $delete_after_days = 80; // 用户新创建的文件将在该设定时间之后自动删除
 $to_line_after_days = 70; // 用户新创建的文件将在该设定的时间之后自动转为低频存储
 
-list($Info, $err) = $bucketManager->bucketLifecycleRule(
+list($ret, $err) = $bucketManager->bucketLifecycleRule(
     $bucket,
     $name,
     $prefix,
     $delete_after_days,
     $to_line_after_days
 );
-if ($err) {
-    print_r($err);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/cdn_get_prefetch_list.php

@@ -16,7 +16,13 @@
 // 参考文档：https://developer.qiniu.com/fusion/api/1227/file-prefetching#4
 
 $requestId = null;     // 指定要查询记录所在的刷新请求id
-$urls = null;              // 要查询的url列表
+
+// 要查询的url列表
+$urls = array(
+    "http://sdk.peterpy.cn/sdktest.png",
+    "http://sdk.peterpy.cn/qiniulogo.png"
+);
+
 $state = 'success';        // 指定要查询记录的状态，取值 processing／success／failure
 $pageNo = 0;               // 要求返回的页号，默认为0
 $pageSize = 100;           // 要求返回的页长度，默认为100

examples/cdn_get_refresh_list.php

@@ -17,7 +17,13 @@
 
 $requestId = 'xxxxxx';     // 指定要查询记录所在的刷新请求id
 $isDir = 'no';             // 指定是否查询目录，取值为yes/no，默认不填则为两种类型记录都查询
-$urls = array();           // 要查询的url列表，每个url可以是文件url，也可以是目录url
+
+// 要查询的url列表，每个url可以是文件url，也可以是目录url
+$urls = array(
+    "http://sdk.peterpy.cn/sdktest.png",
+    "http://sdk.peterpy.cn/qiniulogo.png"
+);
+
 $state = 'success';        // 指定要查询记录的状态，取值 processing／success／failure
 $pageNo = 0;               // 要求返回的页号，默认为0
 $pageSize = 100;           // 要求返回的页长度，默认为100

examples/delete_bucket.php

@@ -19,9 +19,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->deleteBucket($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->deleteBucket($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/delete_bucketEvent.php

@@ -20,9 +20,9 @@
 
 $name = 'demo'; // 规则名称 bucket 内唯一，由 1 ~ 50 个字符组成，可包含：字母、数字和下划线
 
-list($Info, $err) = $bucketManager->deleteBucketEvent($bucket, $name);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->deleteBucketEvent($bucket, $name);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/delete_bucketLifecycleRule.php

@@ -19,9 +19,9 @@
 $bucket = 'xxxx'; // 存储空间名称
 $name = 'demo'; // 生命周期规则名称
 
-list($Info, $err) = $bucketManager->deleteBucketLifecycleRule($bucket, $name);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->deleteBucketLifecycleRule($bucket, $name);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketEvents.php

@@ -18,9 +18,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->getBucketEvents($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->getBucketEvents($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketLifecycleRules.php

@@ -18,9 +18,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->getBucketLifecycleRules($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->getBucketLifecycleRules($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketList.php

@@ -18,9 +18,9 @@
 
 $region = 'z1';  // 华东：z0，华北：z1，华南：z2，北美：na0，东南亚：as0
 
-list($Info, $err) = $bucketManager->listbuckets($region);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->listbuckets($region);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketQuota.php

@@ -18,9 +18,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->getBucketQuota($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->getBucketQuota($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketinfo.php

@@ -17,9 +17,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->bucketInfo($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->bucketInfo($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_bucketinfos.php

@@ -18,9 +18,9 @@
 
 $region = 'z1';  // 华东：z0，华北：z1，华南：z2，北美：na0，东南亚：as0
 
-list($Info, $err) = $bucketManager->bucketInfos($region);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->bucketInfos($region);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/get_corsRules.php

@@ -18,9 +18,9 @@
 
 $bucket = 'xxxx'; // 存储空间名称
 
-list($Info, $err) = $bucketManager->getCorsRules($bucket);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->getCorsRules($bucket);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/image_url_builder.php

@@ -38,12 +38,12 @@
  *
  * @param  string $url 图片链接
  * @param  string $image 水印图片链接
- * @param  numeric $dissolve 透明度 [可选]
+ * @param  int $dissolve 透明度 [可选]
  * @param  string $gravity 水印位置 [可选]
- * @param  numeric $dx 横轴边距 [可选]
- * @param  numeric $dy 纵轴边距 [可选]
- * @param  numeric $watermarkScale 自适应原图的短边比例 [可选]
- * @link   http://developer.qiniu.com/code/v6/api/kodo-api/image/watermark.html
+ * @param  int $dx 横轴边距 [可选]
+ * @param  int $dy 纵轴边距 [可选]
+ * @param  int $watermarkScale 自适应原图的短边比例 [可选]
+ * @link   https://developer.qiniu.com/dora/api/1316/image-watermarking-processing-watermark
  * @return string
  * @author Sherlock Ren <sherlock_ren@icloud.com>
  */
@@ -60,10 +60,10 @@
  * @param  string $font 文字字体
  * @param  string $fontSize 文字字号
  * @param  string $fontColor 文字颜色 [可选]
- * @param  numeric $dissolve 透明度 [可选]
+ * @param  int $dissolve 透明度 [可选]
  * @param  string $gravity 水印位置 [可选]
- * @param  numeric $dx 横轴边距 [可选]
- * @param  numeric $dy 纵轴边距 [可选]
+ * @param  int $dx 横轴边距 [可选]
+ * @param  int $dy 纵轴边距 [可选]
  * @link   http://developer.qiniu.com/code/v6/api/kodo-api/image/watermark.html#text-watermark
  * @return string
  * @author Sherlock Ren <sherlock_ren@icloud.com>

examples/persistent_fop_init.php

@@ -3,18 +3,16 @@
 require_once __DIR__ . '/../autoload.php';
 
 use Qiniu\Auth;
+use Qiniu\Config;
 use Qiniu\Processing\PersistentFop;
 
 // 控制台获取密钥：https://portal.qiniu.com/user/key
 $accessKey = getenv('QINIU_ACCESS_KEY');
 $secretKey = getenv('QINIU_SECRET_KEY');
 $auth = new Auth($accessKey, $secretKey);
 
-// 要转码的文件所在的空间。
-$bucket = 'Bucket_Name';
-
-// 用户默认没有私有队列，需要在这里创建然后填写 https://portal.qiniu.com/dora/media-gate/pipeline
-$pipeline = 'pipeline_name';
+$config = new Config();
+$config->useHTTPS=true;
 
 // 初始化
-$pfop = new PersistentFop($auth, $bucket, $pipeline);
+$pfop = new PersistentFop($auth, $config);

examples/persistent_fop_status.php

@@ -12,9 +12,8 @@
 $persistentId = 'z2.01z201c4oyre6q1hgy00murnel0002nh';
 
 list($ret, $err) = $pfop->status($persistentId);
-
-if ($err) {
-    print_r($err);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($ret);
+    var_dump($ret);
 }

examples/prefop.php

@@ -2,22 +2,18 @@
 require_once __DIR__ . '/../autoload.php';
 
 use Qiniu\Auth;
+use Qiniu\Config;
 use Qiniu\Processing\PersistentFop;
 
 // 控制台获取密钥：https://portal.qiniu.com/user/key
 $accessKey = getenv('QINIU_ACCESS_KEY');
 $secretKey = getenv('QINIU_SECRET_KEY');
 $auth = new Auth($accessKey, $secretKey);
 
-// 要持久化处理的文件所在的空间
-$bucket = 'Bucket_Name';
+$config = new Config();
+$config->useHTTPS=true;
 
-// 用户默认没有私有队列，需要在这里创建然后填写 https://portal.qiniu.com/dora/media-gate/pipeline
-$pipeline = 'pipeline_name';
-
-// 持久化处理完成后通知到你的业务服务器（需要可以公网访问，并能够相应 200 OK）
-$notifyUrl = 'http://375dec79.ngrok.com/notify.php';
-$pfop = new PersistentFop($auth, $bucket, $pipeline, $notifyUrl);
+$pfop = new PersistentFop($auth, $config);
 
 $id = "z2.01z201c4oyre6q1hgy00murnel0002nh";
 

examples/put_bucketAccessMode.php

@@ -19,9 +19,9 @@
 // 设置 Bucket 访问权限
 // 参考文档：https://developer.qiniu.com/kodo/api/3946/set-bucket-private
 
-list($Info, $err) = $bucketManager->putBucketAccessMode($bucket, $private);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putBucketAccessMode($bucket, $private);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/put_bucketAccessStyleMode.php

@@ -19,9 +19,9 @@
 // 存储空间 - 原图保护开关
 // 原图保护：https://developer.qiniu.com/kodo/kb/1359/what-is-the-original-protection
 
-list($Info, $err) = $bucketManager->putBucketAccessStyleMode($bucket, $mode);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putBucketAccessStyleMode($bucket, $mode);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/put_bucketEvent.php

@@ -24,9 +24,9 @@
 $event = array("move","copy");
 $callbackURL = 'http://www.qiniu.com'; // 回调服务器地址，需要可以公网访问，并能够相应 200 OK
 
-list($Info, $err) = $bucketManager->putBucketEvent($bucket, $name, $prefix, $suffix, $event, $callbackURL);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putBucketEvent($bucket, $name, $prefix, $suffix, $event, $callbackURL);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/put_bucketMaxAge.php

@@ -19,9 +19,9 @@
 $bucket = getenv('QINIU_TEST_BUCKET');
 $maxAge = 31536000;
 
-list($Info, $err) = $bucketManager->putBucketMaxAge($bucket, $maxAge);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putBucketMaxAge($bucket, $maxAge);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/put_bucketQuota.php

@@ -21,9 +21,9 @@
 $size = 99999;
 $count = 99;
 
-list($Info, $err) = $bucketManager->putBucketQuota($bucket, $size, $count);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putBucketQuota($bucket, $size, $count);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }

examples/put_referAntiLeech.php

@@ -22,9 +22,9 @@
 $norefer = "1"; // 表示不允许空 Refer 访问：0，表示允许空 Refer 访问：1
 $pattern = "*.qiniu.com"; // 当前仅支持这三种格式：a.b.com，*.b.com，*
 
-list($Info, $err) = $bucketManager->putReferAntiLeech($bucket, $mode, $norefer, $pattern);
-if ($err) {
-    print_r($err);
+list($ret, $err) = $bucketManager->putReferAntiLeech($bucket, $mode, $norefer, $pattern);
+if ($err != null) {
+    var_dump($err);
 } else {
-    print_r($Info);
+    var_dump($ret);
 }