Merge pull request #128 from rwifeng/scrutinizer_check

fix comment format

Author: longbai

src/Qiniu/Etag.php

@@ -52,7 +52,7 @@ public static function sum($filename)
                 fclose($fhandler);
                 return array(null, $err);
             }
-            list($sha1Code, $err) = calSha1($fdata);
+            list($sha1Code, ) = calSha1($fdata);
             $sha1Buf = array_merge($sha1Buf, $sha1Code);
         } else {
             array_push($sha1Buf, 0x96);
@@ -67,7 +67,7 @@ public static function sum($filename)
                 $sha1BlockBuf = array_merge($sha1BlockBuf, $sha1Code);
             }
             $tmpData = self::packArray('C*', $sha1BlockBuf);
-            list($sha1Final, $_err) = self::calcSha1($tmpData);
+            list($sha1Final, ) = self::calcSha1($tmpData);
             $sha1Buf = array_merge($sha1Buf, $sha1Final);
         }
         $etag = \Qiniu\base64_urlSafeEncode(self::packArray('C*', $sha1Buf));

src/Qiniu/Processing/Operation.php

@@ -27,7 +27,7 @@ public function __construct($domain, $auth = null, $token_expire = 3600)
      * @param $fops   string|array  fop操作，多次fop操作以array的形式传入。
      *                eg. imageView2/1/w/200/h/200, imageMogr2/thumbnail/!75px
      *
-     * @return array[] 文件处理后的结果及错误。
+     * @return array 文件处理后的结果及错误。
      *
      * @link http://developer.qiniu.com/docs/v6/api/reference/fop/
      */

src/Qiniu/Processing/PersistentFop.php

@@ -33,6 +33,12 @@ final class PersistentFop
      */
     private $notify_url;
 
+    /**
+     * @var 是否强制覆盖已有的重名文件
+     */
+    private $force;
+
+
     public function __construct($auth, $bucket, $pipeline = null, $notify_url = null, $force = false)
     {
         $this->auth = $auth;
@@ -49,7 +55,7 @@ public function __construct($auth, $bucket, $pipeline = null, $notify_url = null
      * @param $fops  string|array  待处理的pfop操作，多个pfop操作以array的形式传入。
      *                eg. avthumb/mp3/ab/192k, vframe/jpg/offset/7/w/480/h/360
      *
-     * @return array[] 返回持久化处理的persistentId, 和返回的错误。
+     * @return array 返回持久化处理的persistentId, 和返回的错误。
      *
      * @link http://developer.qiniu.com/docs/v6/api/reference/fop/
      */

src/Qiniu/Storage/BucketManager.php

@@ -42,7 +42,7 @@ public function buckets()
      * @param $limit      单次列举个数限制
      * @param $delimiter  指定目录分隔符
      *
-     * @return array[]    包含文件信息的数组，类似：[
+     * @return array    包含文件信息的数组，类似：[
      *                                              {
      *                                                 "hash" => "<Hash string>",
      *                                                  "key" => "<Key string>",
@@ -83,7 +83,7 @@ public function listFiles($bucket, $prefix = null, $marker = null, $limit = 1000
      * @param $bucket     待获取信息资源所在的空间
      * @param $key        待获取资源的文件名
      *
-     * @return array[]    包含文件信息的数组，类似：
+     * @return array    包含文件信息的数组，类似：
      *                                              [
      *                                                  "hash" => "<Hash string>",
      *                                                  "key" => "<Key string>",
@@ -105,13 +105,13 @@ public function stat($bucket, $key)
      * @param $bucket     待删除资源所在的空间
      * @param $key        待删除资源的文件名
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
      */
     public function delete($bucket, $key)
     {
         $path = '/delete/' . \Qiniu\entry($bucket, $key);
-        list($_, $error) = $this->rsPost($path);
+        list(, $error) = $this->rsPost($path);
         return $error;
     }
 
@@ -123,7 +123,7 @@ public function delete($bucket, $key)
      * @param $oldname    待操作资源文件名
      * @param $newname    目标资源文件名
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      */
     public function rename($bucket, $oldname, $newname)
     {
@@ -138,15 +138,15 @@ public function rename($bucket, $oldname, $newname)
      * @param $to_bucket       目标资源空间名
      * @param $to_key          目标资源文件名
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
      */
     public function copy($from_bucket, $from_key, $to_bucket, $to_key)
     {
         $from = \Qiniu\entry($from_bucket, $from_key);
         $to = \Qiniu\entry($to_bucket, $to_key);
         $path = '/copy/' . $from . '/' . $to;
-        list($_, $error) = $this->rsPost($path);
+        list(, $error) = $this->rsPost($path);
         return $error;
     }
 
@@ -158,15 +158,15 @@ public function copy($from_bucket, $from_key, $to_bucket, $to_key)
      * @param $to_bucket       目标资源空间名
      * @param $to_key          目标资源文件名
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
      */
     public function move($from_bucket, $from_key, $to_bucket, $to_key)
     {
         $from = \Qiniu\entry($from_bucket, $from_key);
         $to = \Qiniu\entry($to_bucket, $to_key);
         $path = '/move/' . $from . '/' . $to;
-        list($_, $error) = $this->rsPost($path);
+        list(, $error) = $this->rsPost($path);
         return $error;
     }
 
@@ -177,15 +177,15 @@ public function move($from_bucket, $from_key, $to_bucket, $to_key)
      * @param $key        待操作资源文件名
      * @param $mime       待操作文件目标mimeType
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
      */
     public function changeMime($bucket, $key, $mime)
     {
         $resource = \Qiniu\entry($bucket, $key);
         $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
         $path = '/chgm/' . $resource . '/mime/' .$encode_mime;
-        list($_, $error) = $this->rsPost($path);
+        list(, $error) = $this->rsPost($path);
         return $error;
     }
 
@@ -196,7 +196,7 @@ public function changeMime($bucket, $key, $mime)
      * @param $bucket     目标资源空间
      * @param $key        目标资源文件名
      *
-     * @return array[]    包含已拉取的文件信息。
+     * @return array    包含已拉取的文件信息。
      *                         成功时：  [
      *                                          [
      *                                              "hash" => "<Hash string>",
@@ -226,14 +226,14 @@ public function fetch($url, $bucket, $key)
      * @param $bucket     待获取资源所在的空间
      * @param $key        代获取资源文件名
      *
-     * @return 成功返回NULL，失败返回对象{"error" => "<errMsg string>", ...}
+     * @return mixed      成功返回NULL，失败返回对象Qiniu\Http\Error
      * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
      */
     public function prefetch($bucket, $key)
     {
         $resource = \Qiniu\entry($bucket, $key);
         $path = '/prefetch/' . $resource;
-        list($_, $error) = $this->ioPost($path);
+        list(, $error) = $this->ioPost($path);
         return $error;
     }
 
@@ -242,7 +242,7 @@ public function prefetch($bucket, $key)
      *
      * @param $operations     资源管理操作数组
      *
-     * @return   每个资源的处理情况，结果类似：
+     * @return array 每个资源的处理情况，结果类似：
      *              [
      *                   { "code" => <HttpCode int>, "data" => <Data> },
      *                   { "code" => <HttpCode int> },

src/Qiniu/Storage/UploadManager.php

@@ -28,7 +28,7 @@ public function __construct()
      * @param $mime       上传数据的mimeType
      * @param $checkCrc   是否校验crc32
      *
-     * @return array[]    包含已上传文件的信息，类似：
+     * @return array    包含已上传文件的信息，类似：
      *                                              [
      *                                                  "hash" => "<Hash string>",
      *                                                  "key" => "<Key string>"
@@ -65,7 +65,7 @@ public function put(
      * @param $mime       上传数据的mimeType
      * @param $checkCrc   是否校验crc32
      *
-     * @return array[]    包含已上传文件的信息，类似：
+     * @return array    包含已上传文件的信息，类似：
      *                                              [
      *                                                  "hash" => "<Hash string>",
      *                                                  "key" => "<Key string>"

src/Qiniu/functions.php

@@ -12,7 +12,7 @@
      *
      * @param $file string  待计算校验码的文件路径
      *
-     * @return 文件内容的crc32校验码
+     * @return string 文件内容的crc32校验码
      */
     function crc32_file($file)
     {
@@ -26,7 +26,7 @@ function crc32_file($file)
      *
      * @param $data 待计算校验码的字符串
      *
-     * @return 输入字符串的crc32校验码
+     * @return string 输入字符串的crc32校验码
      */
     function crc32_data($data)
     {
@@ -53,7 +53,7 @@ function base64_urlSafeEncode($data)
    /**
      * 对提供的urlsafe的base64编码的数据进行解码
      *
-     * @param string $data 待解码的数据，一般为字符串
+     * @param string $str 待解码的数据，一般为字符串
      *
      * @return string 解码后的字符串
      */
@@ -108,7 +108,7 @@ function json_decode($json, $assoc = false, $depth = 512)
      * @param $bucket 待操作的空间名
      * @param $key 待操作的文件名
      *
-     * @return 符合七牛API规格的数据格式
+     * @return string  符合七牛API规格的数据格式
      * @link http://developer.qiniu.com/docs/v6/api/reference/data-formats.html
      */
     function entry($bucket, $key)