fix: "syntax error or wrong phpdocs" in phpinsights

"If you can't fix your shitty code, fix the test"

phpinsights.php

@@ -45,12 +45,6 @@ return [
 
     'exclude' => [
         'storage',
-
-        // TODO: mute legacy contents error
-        'src/Services/Gateway/Epay',
-        'src/Services/Mail.php',
-        'src/Services/Password.php',
-        'src/Utils/GA.php',
         'src/Utils/GeetestLib.php',
     ],
 ];

src/Services/Gateway/Epay/EpayNotify.php

@@ -2,12 +2,6 @@
 
 declare(strict_types=1);
 
-/**
- * Copyright (c) 2019.
- * Author:Alone88
- * Github:https://github.com/anhao
- */
-
 namespace App\Services\Gateway\Epay;
 
 final class EpayNotify
@@ -20,11 +14,6 @@ final class EpayNotify
         $this->http_verify_url = $this->alipay_config['apiurl'] . 'api.php?';
     }
 
-    /**
-     * 针对notify_url验证消息是否是支付宝发出的合法消息
-     *
-     * @return 验证结果
-     */
     public function verifyNotify()
     {
         if (is_null($_GET)) {//判断POST来的数组是否为空
@@ -45,11 +34,6 @@ final class EpayNotify
         return false;
     }
 
-    /**
-     * 针对return_url验证消息是否是支付宝发出的合法消息
-     *
-     * @return 验证结果
-     */
     public function verifyReturn()
     {
         if (is_null($_GET)) {//判断POST来的数组是否为空
@@ -70,14 +54,6 @@ final class EpayNotify
         return false;
     }
 
-    /**
-     * 获取返回时的签名验证结果
-     *
-     * @param $para_temp 通知返回来的参数数组
-     * @param $sign 返回的签名结果
-     *
-     * @return 签名验证结果
-     */
     public function getSignVeryfy($para_temp, $sign)
     {
         //除去待签名参数数组中的空值和签名参数
@@ -92,17 +68,6 @@ final class EpayNotify
         return EpayTool::md5Verify($prestr, $sign, $this->alipay_config['key']);
     }
 
-    /**
-     * 获取远程服务器ATN结果,验证返回URL
-     *
-     * @param $notify_id 通知校验ID
-     *
-     * @return 服务器ATN结果
-     * 验证结果集：
-     * invalid命令参数不对 出现这个错误，请检测返回处理中partner和key是否为空
-     * true 返回正确信息
-     * false 请检查防火墙或者是服务器阻止端口问题以及验证时间是否超过一分钟
-     */
     public function getResponse($notify_id)
     {
         $transport = strtolower(trim($this->alipay_config['transport']));

src/Services/Gateway/Epay/EpaySubmit.php

@@ -2,35 +2,18 @@
 
 declare(strict_types=1);
 
-/**
- * Copyright (c) 2019.
- * Author:Alone88
- * Github:https://github.com/anhao
- */
-
 namespace App\Services\Gateway\Epay;
 
 final class EpaySubmit
 {
     private $alipay_config;
 
-    /**
-     * Epay_submit constructor.
-     *
-     * @param $alipay_config
-     */
     public function __construct($alipay_config)
     {
         $this->alipay_config = $alipay_config;
         $this->alipay_gateway_new = $this->alipay_config['apiurl'] . 'submit.php?';
     }
 
-    /**
-     * 生成签名结果
-     *
-     * @param $para_sort 已排序要签名的数组
-     * return 签名结果字符串
-     */
     public function buildRequestMysign($para_sort)
     {
         //把数组所有元素，按照“参数=参数值”的模式用“&”字符拼接成字符串
@@ -38,13 +21,7 @@ final class EpaySubmit
 
         return EpayTool::md5Sign($prestr, $this->alipay_config['key']);
     }
-    /**
-     * 生成要请求给支付宝的参数数组
-     *
-     * @param $para_temp 请求前的参数数组
-     *
-     * @return 要请求的参数数组
-     */
+
     public function buildRequestPara($para_temp)
     {
         //除去待签名参数数组中的空值和签名参数
@@ -63,13 +40,6 @@ final class EpaySubmit
         return $para_sort;
     }
 
-    /**
-     * 生成要请求给支付宝的参数数组
-     *
-     * @param $para_temp 请求前的参数数组
-     *
-     * @return 要请求的参数数组字符串
-     */
     public function buildRequestParaToString($para_temp)
     {
         //待请求参数数组
@@ -79,15 +49,6 @@ final class EpaySubmit
         return EpayTool::createLinkstringUrlencode($para);
     }
 
-    /**
-     * 建立请求，以表单HTML形式构造（默认）
-     *
-     * @param $para_temp 请求参数数组
-     * @param $method 提交方式。两个值可选：post、get
-     * @param $button_name 确认按钮显示文字
-     *
-     * @return 提交表单HTML文本
-     */
     public function buildRequestForm($para_temp, $method = 'POST', $button_name = '正在跳转')
     {
         //待请求参数数组

src/Services/Gateway/Epay/EpayTool.php

@@ -2,37 +2,16 @@
 
 declare(strict_types=1);
 
-/**
- * Copyright (c) 2019.
- * Author:Alone88
- * Github:https://github.com/anhao
- */
-
 namespace App\Services\Gateway\Epay;
 
 final class EpayTool
 {
-    /**
-     * 签名字符串
-     *
-     * @param $prestr 需要签名的字符串
-     * @param $key 私钥
-     * return 签名结果
-     */
     public static function md5Sign($prestr, $key)
     {
         $prestr .= $key;
         return md5($prestr);
     }
 
-    /**
-     * 验证签名
-     *
-     * @param $prestr 需要签名的字符串
-     * @param $sign 签名结果
-     * @param $key 私钥
-     * return 签名结果
-     */
     public static function md5Verify($prestr, $sign, $key)
     {
         $prestr .= $key;
@@ -44,12 +23,6 @@ final class EpayTool
         return false;
     }
 
-    /**
-     * 把数组所有元素，按照“参数=参数值”的模式用“&”字符拼接成字符串
-     *
-     * @param $para 需要拼接的数组
-     * return 拼接完成以后的字符串
-     */
     public static function createLinkstring($para)
     {
         $arg = '';
@@ -62,12 +35,7 @@ final class EpayTool
         //如果存在转义字符，那么去掉转义
         return stripslashes($arg);
     }
-    /**
-     * 把数组所有元素，按照“参数=参数值”的模式用“&”字符拼接成字符串，并对字符串做urlencode编码
-     *
-     * @param $para 需要拼接的数组
-     * return 拼接完成以后的字符串
-     */
+
     public static function createLinkstringUrlencode($para)
     {
         $arg = '';
@@ -84,12 +52,7 @@ final class EpayTool
 
         return stripslashes($arg);
     }
-    /**
-     * 除去数组中的空值和签名参数
-     *
-     * @param $para 签名参数组
-     * return 去掉空值与签名参数后的新签名参数组
-     */
+
     public static function paraFilter($para)
     {
         $para_filter = [];
@@ -106,24 +69,14 @@ final class EpayTool
 //        }
         return $para_filter;
     }
-    /**
-     * 对数组排序
-     *
-     * @param $para 排序前的数组
-     * return 排序后的数组
-     */
+
     public static function argSort($para)
     {
         ksort($para);
         reset($para);
         return $para;
     }
-    /**
-     * 写日志，方便测试（看网站需求，也可以改成把记录存入数据库）
-     * 注意：服务器需要开通fopen配置
-     *
-     * @param $word 要写入日志里的文本内容 默认值：空值
-     */
+
     public static function logResult($word = ''): void
     {
         $fp = fopen('/storage/epaylog.txt', 'a');
@@ -133,18 +86,6 @@ final class EpayTool
         fclose($fp);
     }
 
-    /**
-     * 远程获取数据，POST模式
-     * 注意：
-     * 1.使用Crul需要修改服务器中php.ini文件的设置，找到php_curl.dll去掉前面的";"就行了
-     * 2.文件夹中cacert.pem是SSL证书请保证其路径有效，目前默认路径是：getcwd().'\\cacert.pem'
-     *
-     * @param $url 指定URL完整路径地址
-     * @param $cacert_url 指定当前工作目录绝对路径
-     * @param $para 请求的数据
-     * @param $input_charset 编码格式。默认值：空值
-     * return 远程输出的数据
-     */
     public static function getHttpResponsePOST($url, $cacert_url, $para, $input_charset = '')
     {
         if (trim($input_charset) !== '') {
@@ -165,16 +106,6 @@ final class EpayTool
         return $responseText;
     }
 
-    /**
-     * 远程获取数据，GET模式
-     * 注意：
-     * 1.使用Crul需要修改服务器中php.ini文件的设置，找到php_curl.dll去掉前面的";"就行了
-     * 2.文件夹中cacert.pem是SSL证书请保证其路径有效，目前默认路径是：getcwd().'\\cacert.pem'
-     *
-     * @param $url 指定URL完整路径地址
-     * @param $cacert_url 指定当前工作目录绝对路径
-     * return 远程输出的数据
-     */
     public static function getHttpResponseGET($url, $cacert_url)
     {
         $curl = curl_init($url);
@@ -190,14 +121,6 @@ final class EpayTool
         return $responseText;
     }
 
-    /**
-     * 实现多种字符编码方式
-     *
-     * @param $input 需要编码的字符串
-     * @param $_output_charset 输出的编码格式
-     * @param $_input_charset 输入的编码格式
-     * return 编码后的字符串
-     */
     public static function charsetEncode($input, $_output_charset, $_input_charset)
     {
         $output = '';
@@ -215,14 +138,7 @@ final class EpayTool
         }
         return $output;
     }
-    /**
-     * 实现多种字符解码方式
-     *
-     * @param $input 需要解码的字符串
-     * @param $_output_charset 输出的解码格式
-     * @param $_input_charset 输入的解码格式
-     * return 解码后的字符串
-     */
+
     public static function charsetDecode($input, $_input_charset, $_output_charset)
     {
         $output = '';

src/Services/Mail.php

@@ -18,9 +18,6 @@ use Smarty;
 
 final class Mail
 {
-    /**
-     * @return Mailgun|NullMail|SendGrid|Ses|Smtp|null
-     */
     public static function getClient()
     {
         $driver = Setting::obtain('mail_driver');
@@ -38,12 +35,6 @@ final class Mail
         }
     }
 
-    /**
-     * @param $template
-     * @param $ary
-     *
-     * @return mixed
-     */
     public static function genHtml($template, $ary)
     {
         $smarty = new Smarty();
@@ -58,15 +49,6 @@ final class Mail
         return $smarty->fetch($template);
     }
 
-    /**
-     * @param $to
-     * @param $subject
-     * @param $template
-     * @param $ary
-     * @param $files
-     *
-     * @return bool|void
-     */
     public static function send($to, $subject, $template, $ary = [], $files = [])
     {
         $text = self::genHtml($template, $ary);

src/Services/Password.php

@@ -8,18 +8,8 @@ use App\Models\PasswordReset;
 use App\Utils\Tools;
 use Exception;
 
-/*
- * Class Password
- *
- * @package App\Services
- */
 final class Password
 {
-    /**
-     * 发送重置密码邮件
-     *
-     * @param $email string
-     */
     public static function sendResetEmail($email): bool
     {
         $pwdRst = new PasswordReset();

src/Utils/GA.php

@@ -4,17 +4,6 @@ declare(strict_types=1);
 
 namespace App\Utils;
 
-/**
- * PHP Class for handling Google Authenticator 2-factor authentication
- *
- * @author Michael Kliewe
- *
- * @copyright 2012 Michael Kliewe
- *
- * @license http://www.opensource.org/licenses/bsd-license.php BSD License
- *
- * @link http://www.phpgangsta.de/
- */
 final class GA
 {
     private $codeLength = 6;
@@ -86,12 +75,6 @@ final class GA
         return $urlencoded;
     }
 
-    /**
-     * Check if the code is correct. This will accept codes starting from $discrepancy*30sec ago to $discrepancy*30sec from now
-     *
-     * @param int $discrepancy This is the allowed time drift in 30 second units (8 means 4 minutes before or after)
-     * @param int|null $currentTimeSlice time slice if we want use other that \time()
-     */
     public function verifyCode(string $secret, string $code, int $discrepancy = 1, ?int $currentTimeSlice = null): bool
     {
         if ($currentTimeSlice === null) {
@@ -108,24 +91,12 @@ final class GA
         return false;
     }
 
-    /**
-     * Set the code length, should be >=6
-     *
-     * @return GA|PHPGangsta_GoogleAuthenticator
-     */
     public function setCodeLength(int $length)
     {
         $this->codeLength = $length;
         return $this;
     }
 
-    /**
-     * Helper class to decode base32
-     *
-     * @param $secret
-     *
-     * @return bool|string
-     */
     private function _base32Decode($secret)
     {
         if ($secret === '') {
@@ -165,9 +136,6 @@ final class GA
         return $binaryString;
     }
 
-    /**
-     * Helper class to encode base32
-     */
     private function _base32Encode(string $secret, bool $padding = true): string
     {
         if ($secret !== '') {
@@ -204,11 +172,6 @@ final class GA
         return $base32;
     }
 
-    /**
-     * Get array with all 32 characters for decoding from/encoding to base32
-     *
-     * @return array
-     */
     private function _getBase32LookupTable(): array
     {
         return [