REST::sendTemplateSMS() - Code Metrics - Inspection of "fixbug" - toplan/phpsms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by lan tian

created 2016-01-11 11:38 UTC

REST::sendTemplateSMS() C

↳ Parent: REST

Complexity

Conditions	8
Paths	25

Size

Total Lines	51
Code Lines	32

Duplication

Lines	11
Ratio	21.57 %

Metric	Value
dl	11
loc	51
rs	6.5979
cc	8
eloc	32
nc	25
nop	3

How to fix Long Method



<?php
/*
 *  Copyright (c) 2014 The CCP project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a Beijing Speedtong Information Technology Co.,Ltd license
 *  that can be found in the LICENSE file in the root of the web site.
 *
 *   http://www.yuntongxun.com
 *
 *  An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

class REST
namespace YourVendor;

class YourClass { }
{
    private $AccountSid;
    private $AccountToken;
    private $AppId;
    private $ServerIP;
    private $ServerPort;
    private $SoftVersion;
    private $Batch;  //时间戳
    private $BodyType = 'xml'; //包体格式，可填值：json 、xml

    public function __construct($ServerIP, $ServerPort, $SoftVersion)
    {
        $this->Batch = date('YmdHis');
        $this->ServerIP = $ServerIP;
        $this->ServerPort = $ServerPort;
        $this->SoftVersion = $SoftVersion;
    }

    /**
     * 设置主帐号
     * 
     * @param string $AccountSid   主帐号
     * @param string $AccountToken 主帐号Token
     */
    public function setAccount($AccountSid, $AccountToken)
    {
        $this->AccountSid = $AccountSid;
        $this->AccountToken = $AccountToken;
    }

    /**
     * 设置应用ID
     * 
     * @param string $AppId 应用ID
     */
    public function setAppId($AppId)
    {
        $this->AppId = $AppId;
    }

     /**
      * 发起HTTPS请求
      *
      * @param string $url
      * @param mixed $data
      * @param mixed $header
      * @param mixed $post
      *
      * @return mixed
      */
     public function curl_post($url, $data, $header, $post = 1)
     {
         //初始化curl
         $ch = curl_init();
         //参数设置
         $res = curl_setopt($ch, CURLOPT_URL, $url);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
         curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
         curl_setopt($ch, CURLOPT_HEADER, 0);
         curl_setopt($ch, CURLOPT_POST, $post);
         if ($post) {
             curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
         }
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
         curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
         $result = curl_exec($ch);
         //连接失败
         if ($result === false) {
             if ($this->BodyType === 'json') {
                 $result = '{"statusCode":"172001","statusMsg":"网络错误"}';
             } else {
                 $result = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Response><statusCode>172001</statusCode><statusMsg>网络错误</statusMsg></Response>';
             }
         }
         curl_close($ch);

         return $result;
     }

    /**
     * 发送模板短信
     *
     * @param string $to
     *                       短信接收彿手机号码集合,用英文逗号分开
     * @param array  $datas
     *                       内容数据
     * @param mixed  $tempId
     *                       模板Id
     *
     * @return mixed
     */
    public function sendTemplateSMS($to, $datas, $tempId)
    {
        //主帐号鉴权信息验证，对必选参数进行判空。
        $auth = $this->accAuth();
        if ($auth !== true) {
            return $auth;
        }
        // 拼接请求包体
        if ($this->BodyType === 'json') {
            $data = '';
            for ($i = 0; $i < count($datas); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $data = $data . "'" . $datas[$i] . "',";
            }
            $body = "{'to':'$to','templateId':'$tempId','appId':'$this->AppId','datas':[" . $data . ']}';
        } else {
            $data = '';
            for ($i = 0; $i < count($datas); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $data = $data . '<data>' . $datas[$i] . '</data>';
            }
            $body = "<TemplateSMS>
                    <to>$to</to> 
                    <appId>$this->AppId</appId>
                    <templateId>$tempId</templateId>
                    <datas>" . $data . '</datas>
                  </TemplateSMS>';
        }
        // 大写的sig参数
        $sig = strtoupper(md5($this->AccountSid . $this->AccountToken . $this->Batch));
        // 生成请求URL
        $url = "https://$this->ServerIP:$this->ServerPort/$this->SoftVersion/Accounts/$this->AccountSid/SMS/TemplateSMS?sig=$sig";
        // 生成授权：主帐户Id + 英文冒号 + 时间戳。
        $authen = base64_encode($this->AccountSid . ':' . $this->Batch);
        // 生成包头
        $header = array("Accept:application/$this->BodyType", "Content-Type:application/$this->BodyType;charset=utf-8", "Authorization:$authen");
        // 发送请求
        $result = $this->curl_post($url, $body, $header);
        if ($this->BodyType === 'json') {//JSON格式

           $datas = json_decode($result);
        } else { //xml格式
           $datas = simplexml_load_string(trim($result, " \t\n\r"));
        }
        //重新装填数据
        if ($datas->statusCode === 0) {
            if ($this->BodyType === 'json') {
                $datas->TemplateSMS = $datas->templateSMS;
                unset($datas->templateSMS);
            }
        }

        return $datas;
    }

    /**
     * 语音验证码
     *
     * @param mixed $verifyCode     验证码内容，为数字和英文字母，不区分大小写，长度4-8位
     * @param mixed $playTimes      播放次数，1－3次
     * @param mixed $to             接收号码
     * @param mixed $displayNum     显示的主叫号码
     * @param mixed $respUrl        语音验证码状态通知回调地址，云通讯平台将向该Url地址发送呼叫结果通知
     * @param mixed $lang           语言类型
     * @param mixed $userData       第三方私有数据
     * @param mixed $welcomePrompt  欢迎提示音，在播放验证码语音前播放此内容（语音文件格式为wav）
     * @param mixed $playVerifyCode 语音验证码的内容全部播放此节点下的全部语音文件
     *
     * @return mixed
     */
    public function voiceVerify($verifyCode, $playTimes, $to, $displayNum, $respUrl, $lang, $userData, $welcomePrompt, $playVerifyCode)
    {
        //主帐号鉴权信息验证，对必选参数进行判空。
        $auth = $this->accAuth();
        if ($auth !== true) {
            return $auth;
        }
        // 拼接请求包体
        if ($this->BodyType === 'json') {
            $body = "{'appId':'$this->AppId','verifyCode':'$verifyCode','playTimes':'$playTimes','to':'$to','respUrl':'$respUrl','displayNum':'$displayNum',
           'lang':'$lang','userData':'$userData','welcomePrompt':'$welcomePrompt','playVerifyCode':'$playVerifyCode'}";
        } else {
            $body = "<VoiceVerify>
                    <appId>$this->AppId</appId>
                    <verifyCode>$verifyCode</verifyCode>
                    <playTimes>$playTimes</playTimes>
                    <to>$to</to>
                    <respUrl>$respUrl</respUrl>
                    <displayNum>$displayNum</displayNum>
                    <lang>$lang</lang>
                    <userData>$userData</userData>
					<welcomePrompt>$welcomePrompt</welcomePrompt>
					<playVerifyCode>$playVerifyCode</playVerifyCode>
                  </VoiceVerify>";
        }
        // 大写的sig参数
        $sig = strtoupper(md5($this->AccountSid . $this->AccountToken . $this->Batch));
        // 生成请求URL
        $url = "https://$this->ServerIP:$this->ServerPort/$this->SoftVersion/Accounts/$this->AccountSid/Calls/VoiceVerify?sig=$sig";
        // 生成授权：主帐户Id + 英文冒号 + 时间戳。
        $authen = base64_encode($this->AccountSid . ':' . $this->Batch);
        // 生成包头
        $header = array("Accept:application/$this->BodyType", "Content-Type:application/$this->BodyType;charset=utf-8", "Authorization:$authen");
        // 发送请求
        $result = $this->curl_post($url, $body, $header);
        if ($this->BodyType === 'json') {//JSON格式

            $datas = json_decode($result);
        } else { //xml格式
            $datas = simplexml_load_string(trim($result, " \t\n\r"));
        }

        return $datas;
    }

   /**
    * 主帐号鉴权
    *
    * @return mixed
    */
   public function accAuth()
   {
       if ($this->ServerIP === '') {
           $data = new stdClass();
           $data->statusCode = '172004';
           $data->statusMsg = 'IP为空';

           return $data;
       }
       if ($this->ServerPort <= 0) {
           $data = new stdClass();
           $data->statusCode = '172005';
           $data->statusMsg = '端口错误（小于等于0）';

           return $data;
       }
       if ($this->SoftVersion === '') {
           $data = new stdClass();
           $data->statusCode = '172013';
           $data->statusMsg = '版本号为空';

           return $data;
       }
       if ($this->AccountSid === '') {
           $data = new stdClass();
           $data->statusCode = '172006';
           $data->statusMsg = '主帐号为空';

           return $data;
       }
       if ($this->AccountToken === '') {
           $data = new stdClass();
           $data->statusCode = '172007';
           $data->statusMsg = '主帐号令牌为空';

           return $data;
       }
       if ($this->AppId === '') {
           $data = new stdClass();
           $data->statusCode = '172012';
           $data->statusMsg = '应用ID为空';

           return $data;
       }

       return true;
   }
}


1
		0 ignored issues – show Security Bug introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report It is not recommended to output anything before PHP's opening tag in non-template files. Loading history... Coding Style Compatibility introduced 2015-12-14 06:16 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 16 and the first side effect is on line 1. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		<?php
3		/*
4		* Copyright (c) 2014 The CCP project authors. All Rights Reserved.
5		*
6		* Use of this source code is governed by a Beijing Speedtong Information Technology Co.,Ltd license
7		* that can be found in the LICENSE file in the root of the web site.
8		*
9		* http://www.yuntongxun.com
10		*
11		* An additional intellectual property rights grant can be found
12		* in the file PATENTS. All contributing project authors may
13		* be found in the AUTHORS file in the root of the source tree.
14		*/
15
16		class REST
		0 ignored issues – show Coding Style Compatibility introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17		{
18		private $AccountSid;
19		private $AccountToken;
20		private $AppId;
21		private $ServerIP;
22		private $ServerPort;
23		private $SoftVersion;
24		private $Batch; //时间戳
25		private $BodyType = 'xml'; //包体格式，可填值：json 、xml
26
27		public function __construct($ServerIP, $ServerPort, $SoftVersion)
28		{
29		$this->Batch = date('YmdHis');
30		$this->ServerIP = $ServerIP;
31		$this->ServerPort = $ServerPort;
32		$this->SoftVersion = $SoftVersion;
33		}
34
35		/**
36		* 设置主帐号
37		*
38		* @param string $AccountSid 主帐号
39		* @param string $AccountToken 主帐号Token
40		*/
41		public function setAccount($AccountSid, $AccountToken)
42		{
43		$this->AccountSid = $AccountSid;
44		$this->AccountToken = $AccountToken;
45		}
46
47		/**
48		* 设置应用ID
49		*
50		* @param string $AppId 应用ID
51		*/
52		public function setAppId($AppId)
53		{
54		$this->AppId = $AppId;
55		}
56
57		/**
58		* 发起HTTPS请求
59		*
60		* @param string $url
61		* @param mixed $data
62		* @param mixed $header
63		* @param mixed $post
64		*
65		* @return mixed
66		*/
67		public function curl_post($url, $data, $header, $post = 1)
68		{
69		//初始化curl
70		$ch = curl_init();
71		//参数设置
72		$res = curl_setopt($ch, CURLOPT_URL, $url);
		0 ignored issues – show Unused Code introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report `$res` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
73		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
74		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
75		curl_setopt($ch, CURLOPT_HEADER, 0);
76		curl_setopt($ch, CURLOPT_POST, $post);
77		if ($post) {
78		curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
79		}
80		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
81		curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
82		$result = curl_exec($ch);
83		//连接失败
84		if ($result === false) {
85		if ($this->BodyType === 'json') {
86		$result = '{"statusCode":"172001","statusMsg":"网络错误"}';
87		} else {
88		$result = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Response><statusCode>172001</statusCode><statusMsg>网络错误</statusMsg></Response>';
89		}
90		}
91		curl_close($ch);
92
93		return $result;
94		}
95
96		/**
97		* 发送模板短信
98		*
99		* @param string $to
100		* 短信接收彿手机号码集合,用英文逗号分开
101		* @param array $datas
102		* 内容数据
103		* @param mixed $tempId
104		* 模板Id
105		*
106		* @return mixed
107		*/
108		public function sendTemplateSMS($to, $datas, $tempId)
109		{
110		//主帐号鉴权信息验证，对必选参数进行判空。
111		$auth = $this->accAuth();
112		if ($auth !== true) {
113		return $auth;
114		}
115		// 拼接请求包体
116		if ($this->BodyType === 'json') {
117		$data = '';
118	View Code Duplication	for ($i = 0; $i < count($datas); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2016-01-11 11:45 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history... Duplication introduced 2016-01-11 11:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119		$data = $data . "'" . $datas[$i] . "',";
120		}
121		$body = "{'to':'$to','templateId':'$tempId','appId':'$this->AppId','datas':[" . $data . ']}';
122		} else {
123		$data = '';
124	View Code Duplication	for ($i = 0; $i < count($datas); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history... Duplication introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125		$data = $data . '<data>' . $datas[$i] . '</data>';
126		}
127		$body = "<TemplateSMS>
128		<to>$to</to>
129		<appId>$this->AppId</appId>
130		<templateId>$tempId</templateId>
131		<datas>" . $data . '</datas>
132		</TemplateSMS>';
133		}
134		// 大写的sig参数
135		$sig = strtoupper(md5($this->AccountSid . $this->AccountToken . $this->Batch));
136		// 生成请求URL
137		$url = "https://$this->ServerIP:$this->ServerPort/$this->SoftVersion/Accounts/$this->AccountSid/SMS/TemplateSMS?sig=$sig";
138		// 生成授权：主帐户Id + 英文冒号 + 时间戳。
139		$authen = base64_encode($this->AccountSid . ':' . $this->Batch);
140		// 生成包头
141		$header = array("Accept:application/$this->BodyType", "Content-Type:application/$this->BodyType;charset=utf-8", "Authorization:$authen");
142		// 发送请求
143		$result = $this->curl_post($url, $body, $header);
144	View Code Duplication	if ($this->BodyType === 'json') {//JSON格式
		0 ignored issues – show Duplication introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
145		$datas = json_decode($result);
146		} else { //xml格式
147		$datas = simplexml_load_string(trim($result, " \t\n\r"));
148		}
149		//重新装填数据
150		if ($datas->statusCode === 0) {
151		if ($this->BodyType === 'json') {
152		$datas->TemplateSMS = $datas->templateSMS;
153		unset($datas->templateSMS);
154		}
155		}
156
157		return $datas;
158		}
159
160		/**
161		* 语音验证码
162		*
163		* @param mixed $verifyCode 验证码内容，为数字和英文字母，不区分大小写，长度4-8位
164		* @param mixed $playTimes 播放次数，1－3次
165		* @param mixed $to 接收号码
166		* @param mixed $displayNum 显示的主叫号码
167		* @param mixed $respUrl 语音验证码状态通知回调地址，云通讯平台将向该Url地址发送呼叫结果通知
168		* @param mixed $lang 语言类型
169		* @param mixed $userData 第三方私有数据
170		* @param mixed $welcomePrompt 欢迎提示音，在播放验证码语音前播放此内容（语音文件格式为wav）
171		* @param mixed $playVerifyCode 语音验证码的内容全部播放此节点下的全部语音文件
172		*
173		* @return mixed
174		*/
175		public function voiceVerify($verifyCode, $playTimes, $to, $displayNum, $respUrl, $lang, $userData, $welcomePrompt, $playVerifyCode)
176		{
177		//主帐号鉴权信息验证，对必选参数进行判空。
178		$auth = $this->accAuth();
179		if ($auth !== true) {
180		return $auth;
181		}
182		// 拼接请求包体
183		if ($this->BodyType === 'json') {
184		$body = "{'appId':'$this->AppId','verifyCode':'$verifyCode','playTimes':'$playTimes','to':'$to','respUrl':'$respUrl','displayNum':'$displayNum',
185		'lang':'$lang','userData':'$userData','welcomePrompt':'$welcomePrompt','playVerifyCode':'$playVerifyCode'}";
186		} else {
187		$body = "<VoiceVerify>
188		<appId>$this->AppId</appId>
189		<verifyCode>$verifyCode</verifyCode>
190		<playTimes>$playTimes</playTimes>
191		<to>$to</to>
192		<respUrl>$respUrl</respUrl>
193		<displayNum>$displayNum</displayNum>
194		<lang>$lang</lang>
195		<userData>$userData</userData>
196		<welcomePrompt>$welcomePrompt</welcomePrompt>
197		<playVerifyCode>$playVerifyCode</playVerifyCode>
198		</VoiceVerify>";
199		}
200		// 大写的sig参数
201		$sig = strtoupper(md5($this->AccountSid . $this->AccountToken . $this->Batch));
202		// 生成请求URL
203		$url = "https://$this->ServerIP:$this->ServerPort/$this->SoftVersion/Accounts/$this->AccountSid/Calls/VoiceVerify?sig=$sig";
204		// 生成授权：主帐户Id + 英文冒号 + 时间戳。
205		$authen = base64_encode($this->AccountSid . ':' . $this->Batch);
206		// 生成包头
207		$header = array("Accept:application/$this->BodyType", "Content-Type:application/$this->BodyType;charset=utf-8", "Authorization:$authen");
208		// 发送请求
209		$result = $this->curl_post($url, $body, $header);
210	View Code Duplication	if ($this->BodyType === 'json') {//JSON格式
		0 ignored issues – show Duplication introduced 2016-01-11 11:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
211		$datas = json_decode($result);
212		} else { //xml格式
213		$datas = simplexml_load_string(trim($result, " \t\n\r"));
214		}
215
216		return $datas;
217		}
218
219		/**
220		* 主帐号鉴权
221		*
222		* @return mixed
223		*/
224		public function accAuth()
225		{
226		if ($this->ServerIP === '') {
227		$data = new stdClass();
228		$data->statusCode = '172004';
229		$data->statusMsg = 'IP为空';
230
231		return $data;
232		}
233		if ($this->ServerPort <= 0) {
234		$data = new stdClass();
235		$data->statusCode = '172005';
236		$data->statusMsg = '端口错误（小于等于0）';
237
238		return $data;
239		}
240		if ($this->SoftVersion === '') {
241		$data = new stdClass();
242		$data->statusCode = '172013';
243		$data->statusMsg = '版本号为空';
244
245		return $data;
246		}
247		if ($this->AccountSid === '') {
248		$data = new stdClass();
249		$data->statusCode = '172006';
250		$data->statusMsg = '主帐号为空';
251
252		return $data;
253		}
254		if ($this->AccountToken === '') {
255		$data = new stdClass();
256		$data->statusCode = '172007';
257		$data->statusMsg = '主帐号令牌为空';
258
259		return $data;
260		}
261		if ($this->AppId === '') {
262		$data = new stdClass();
263		$data->statusCode = '172012';
264		$data->statusMsg = '应用ID为空';
265
266		return $data;
267		}
268
269		return true;
270		}
271		}
272

toplan / phpsms

Pull Request — master (#22)

REST::sendTemplateSMS() C

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like