Client::contactSyncSuccess() - Code Metrics - Inspection of "增加企业微信开放平台部分测试用例" - overtrue/wechat - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1414)

by milkmeowo

created 2018-12-06 15:06 UTC

Client::contactSyncSuccess() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of the overtrue/wechat.
 *
 * (c) overtrue <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace EasyWeChat\OpenWork\Provider;

use EasyWeChat\Kernel\BaseClient;
use EasyWeChat\Kernel\ServiceContainer;

/**
 * Client.
 *
 * @author xiaomin <[email protected]>
 */
class Client extends BaseClient
{
    /**
     * Client constructor.
     *
     *
     * @param ServiceContainer $app
     */
    public function __construct(ServiceContainer $app)
    {
        parent::__construct($app, $app['provider_access_token']);
    }

    /**
     * 单点登录 - 获取登录的地址.
     *
     * @param string $redirectUri
     * @param string $userType
     * @param string $state
     *
     * @return string
     */
    public function getLoginUrl(string $redirectUri = '', string $userType = 'admin', string $state = '')
    {
        $redirectUri || $redirectUri = $this->app->config['redirect_uri_single'];
        $state || $state = rand();
$a = "a";
$ab = "ab";
$abc = "abc";
        $params = [
$a = "a";
$ab = "ab";
$abc = "abc";
            'appid' => $this->app['config']['corp_id'],
            'redirect_uri' => $redirectUri,
            'usertype' => $userType,
            'state' => $state,
        ];

        return 'https://open.work.weixin.qq.com/wwopen/sso/3rd_qrConnect?'.http_build_query($params);
    }

    /**
     * 单点登录 - 获取登录用户信息.
     *
     * @param string $authCode
     *
     * @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function getLoginInfo(string $authCode)
    {
        $params = [
            'auth_code' => $authCode,
        ];

        return $this->httpPostJson('cgi-bin/service/get_login_info', $params);
    }

    /**
     * 获取注册定制化URL.
     *
     * @param string $registerCode
     *
     * @return string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function getRegisterUri(string $registerCode = '')
    {
        $registerCode || $registerCode = $this->getRegisterCode()['register_code'];
        $params = ['register_code' => $registerCode];
$a = "a";
$ab = "ab";
$abc = "abc";

        return 'https://open.work.weixin.qq.com/3rdservice/wework/register?'.http_build_query($params);
    }

    /**
     * 获取注册码.
     *
     * @param string $corpName
     * @param string $adminName
     * @param string $adminMobile
     * @param string $state
     *
     * @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function getRegisterCode(
        string $corpName = '',
        string $adminName = '',
        string $adminMobile = '',
        string $state = ''
    ) {
        $params = [];
$a = "a";
$ab = "ab";
$abc = "abc";
        $params['template_id'] = $this->app['config']['reg_template_id'];
$a = "a";
$ab = "ab";
$abc = "abc";
        !empty($corpName) && $params['corp_name'] = $corpName;
$a = "a";
$ab = "ab";
$abc = "abc";
        !empty($adminName) && $params['admin_name'] = $adminName;
$a = "a";
$ab = "ab";
$abc = "abc";
        !empty($adminMobile) && $params['admin_mobile'] = $adminMobile;
        !empty($state) && $params['state'] = $state;
$a = "a";
$ab = "ab";
$abc = "abc";

        return $this->httpPostJson('cgi-bin/service/get_register_code', $params);
    }

    /**
     * 查询注册状态.
     *
     * Desc:该API用于查询企业注册状态，企业注册成功返回注册信息.
     *
     * @param string $registerCode
     *
     * @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function getRegisterInfo(string $registerCode)
    {
        $params = [
            'register_code' => $registerCode,
        ];

        return $this->httpPostJson('cgi-bin/service/get_register_info', $params);
    }

    /**
     * 设置授权应用可见范围.
     *
     * Desc:调用该接口前提是开启通讯录迁移，收到授权成功通知后可调用。
     *      企业注册初始化安装应用后，应用默认可见范围为根部门。
     *      如需修改应用可见范围，服务商可以调用该接口设置授权应用的可见范围。
     *      该接口只能使用注册完成回调事件或者查询注册状态返回的access_token。
     *      调用设置通讯录同步完成后或者access_token超过30分钟失效（即解除通讯录锁定状态）则不能继续调用该接口。
     *
     * @param string $accessToken
     * @param string $agentId
     * @param array  $allowUser
     * @param array  $allowParty
     * @param array  $allowTag
     *
     * @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function setAgentScope(
        string $accessToken,
        string $agentId,
        array $allowUser = [],
        array $allowParty = [],
        array $allowTag = []
    ) {
        $params = [
            'agentid' => $agentId,
            'allow_user' => $allowUser,
            'allow_party' => $allowParty,
            'allow_tag' => $allowTag,
            'access_token' => $accessToken,
        ];

        return $this->httpGet('cgi-bin/agent/set_scope', $params);
    }

    /**
     * 设置通讯录同步完成.
     *
     * Desc:该API用于设置通讯录同步完成，解除通讯录锁定状态，同时使通讯录迁移access_token失效。
     *
     * @param $accessToken
     *
     * @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
     *
     * @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
     */
    public function contactSyncSuccess(string $accessToken)
    {
        $params = ['access_token' => $accessToken];

        return $this->httpGet('cgi-bin/sync/contact_sync_success', $params);
    }
}


1		<?php
2
3		/*
4		* This file is part of the overtrue/wechat.
5		*
6		* (c) overtrue <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace EasyWeChat\OpenWork\Provider;
13
14		use EasyWeChat\Kernel\BaseClient;
15		use EasyWeChat\Kernel\ServiceContainer;
16
17		/**
18		* Client.
19		*
20		* @author xiaomin <[email protected]>
21		*/
22		class Client extends BaseClient
23		{
24		/**
25		* Client constructor.
26		*
27		*
28		* @param ServiceContainer $app
29		*/
30	1	public function __construct(ServiceContainer $app)
31		{
32	1	parent::__construct($app, $app['provider_access_token']);
33	1	}
34
35		/**
36		* 单点登录 - 获取登录的地址.
37		*
38		* @param string $redirectUri
39		* @param string $userType
40		* @param string $state
41		*
42		* @return string
43		*/
44		public function getLoginUrl(string $redirectUri = '', string $userType = 'admin', string $state = '')
45		{
46		$redirectUri \|\| $redirectUri = $this->app->config['redirect_uri_single'];
47		$state \|\| $state = rand();
		0 ignored issues – show Coding Style introduced 2018-07-03 08:38 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
48		$params = [
		0 ignored issues – show Coding Style introduced 2018-07-03 08:38 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 22 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
49		'appid' => $this->app['config']['corp_id'],
50		'redirect_uri' => $redirectUri,
51		'usertype' => $userType,
52		'state' => $state,
53		];
54
55		return 'https://open.work.weixin.qq.com/wwopen/sso/3rd_qrConnect?'.http_build_query($params);
56		}
57
58		/**
59		* 单点登录 - 获取登录用户信息.
60		*
61		* @param string $authCode
62		*
63		* @return array\|\EasyWeChat\Kernel\Support\Collection\|object\|\Psr\Http\Message\ResponseInterface\|string
64		*
65		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
66		*/
67		public function getLoginInfo(string $authCode)
68		{
69		$params = [
70		'auth_code' => $authCode,
71		];
72
73		return $this->httpPostJson('cgi-bin/service/get_login_info', $params);
74		}
75
76		/**
77		* 获取注册定制化URL.
78		*
79		* @param string $registerCode
80		*
81		* @return string
82		*
83		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
84		*/
85		public function getRegisterUri(string $registerCode = '')
86		{
87		$registerCode \|\| $registerCode = $this->getRegisterCode()['register_code'];
88		$params = ['register_code' => $registerCode];
		0 ignored issues – show Coding Style introduced 2018-07-03 08:38 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 24 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
89
90		return 'https://open.work.weixin.qq.com/3rdservice/wework/register?'.http_build_query($params);
91		}
92
93		/**
94		* 获取注册码.
95		*
96		* @param string $corpName
97		* @param string $adminName
98		* @param string $adminMobile
99		* @param string $state
100		*
101		* @return array\|\EasyWeChat\Kernel\Support\Collection\|object\|\Psr\Http\Message\ResponseInterface\|string
102		*
103		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
104		*/
105		public function getRegisterCode(
106		string $corpName = '',
107		string $adminName = '',
108		string $adminMobile = '',
109		string $state = ''
110		) {
111		$params = [];
		0 ignored issues – show Coding Style introduced 2018-06-28 14:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 41 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
112		$params['template_id'] = $this->app['config']['reg_template_id'];
		0 ignored issues – show Coding Style introduced 2018-06-28 14:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 26 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
113		!empty($corpName) && $params['corp_name'] = $corpName;
		0 ignored issues – show Coding Style introduced 2018-06-28 09:59 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
114		!empty($adminName) && $params['admin_name'] = $adminName;
		0 ignored issues – show Coding Style introduced 2018-06-28 09:59 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
115		!empty($adminMobile) && $params['admin_mobile'] = $adminMobile;
116		!empty($state) && $params['state'] = $state;
		0 ignored issues – show Coding Style introduced 2018-06-28 14:24 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 14 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
117
118		return $this->httpPostJson('cgi-bin/service/get_register_code', $params);
119		}
120
121		/**
122		* 查询注册状态.
123		*
124		* Desc:该API用于查询企业注册状态，企业注册成功返回注册信息.
125		*
126		* @param string $registerCode
127		*
128		* @return array\|\EasyWeChat\Kernel\Support\Collection\|object\|\Psr\Http\Message\ResponseInterface\|string
129		*
130		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
131		*/
132		public function getRegisterInfo(string $registerCode)
133		{
134		$params = [
135		'register_code' => $registerCode,
136		];
137
138		return $this->httpPostJson('cgi-bin/service/get_register_info', $params);
139		}
140
141		/**
142		* 设置授权应用可见范围.
143		*
144		* Desc:调用该接口前提是开启通讯录迁移，收到授权成功通知后可调用。
145		* 企业注册初始化安装应用后，应用默认可见范围为根部门。
146		* 如需修改应用可见范围，服务商可以调用该接口设置授权应用的可见范围。
147		* 该接口只能使用注册完成回调事件或者查询注册状态返回的access_token。
148		* 调用设置通讯录同步完成后或者access_token超过30分钟失效（即解除通讯录锁定状态）则不能继续调用该接口。
149		*
150		* @param string $accessToken
151		* @param string $agentId
152		* @param array $allowUser
153		* @param array $allowParty
154		* @param array $allowTag
155		*
156		* @return array\|\EasyWeChat\Kernel\Support\Collection\|object\|\Psr\Http\Message\ResponseInterface\|string
157		*
158		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
159		*/
160		public function setAgentScope(
161		string $accessToken,
162		string $agentId,
163		array $allowUser = [],
164		array $allowParty = [],
165		array $allowTag = []
166		) {
167		$params = [
168		'agentid' => $agentId,
169		'allow_user' => $allowUser,
170		'allow_party' => $allowParty,
171		'allow_tag' => $allowTag,
172		'access_token' => $accessToken,
173		];
174
175		return $this->httpGet('cgi-bin/agent/set_scope', $params);
176		}
177
178		/**
179		* 设置通讯录同步完成.
180		*
181		* Desc:该API用于设置通讯录同步完成，解除通讯录锁定状态，同时使通讯录迁移access_token失效。
182		*
183		* @param $accessToken
184		*
185		* @return array\|\EasyWeChat\Kernel\Support\Collection\|object\|\Psr\Http\Message\ResponseInterface\|string
186		*
187		* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
188		*/
189		public function contactSyncSuccess(string $accessToken)
190		{
191		$params = ['access_token' => $accessToken];
192
193		return $this->httpGet('cgi-bin/sync/contact_sync_success', $params);
194		}
195		}
196

overtrue / wechat

Pull Request — master (#1414)

Client::contactSyncSuccess() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like