User::batchRemove() - Code Metrics - Inspection of "Test Fix" - lichunqiang/easemob - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 42b611...b70ab3 )

by light

created 2016-01-29 07:59 UTC

User::batchRemove() A

↳ Parent: User

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace light\Easemob\Rest;

use light\Easemob\Support\Log;

/**
 * User operation
 */
class User extends Rest
{
    /**
     * Register users
     *
     * 通过「授权注册」的方式注册用户.
     *
     * @param  array $users
     *
     *  [['username' => '123123', 'password' => 'password', 'nickname' => 'niamee']]
     *
     * @return array|boolean The entities of registed user
     */
    public function register($users)
    {
        $response = $this->post('users', $users);

        return $response ? $response['entities'] : false;
    }

    /**
     * Fetch all user records.
     *
     * @param  string|null $cursor
     * @param  integer $limit
     *
     * @return array|boolean
     */
    public function all($cursor = null, $limit = 20)
    {
        $result = $this->get('users', ['limit' => $limit, 'cursor' => $cursor]);

        if (false === $result) {
            return false;
        }

        return [
            'items' => $result['entities'],
            'cursor' => isset($result['cursor']) ? $result['cursor'] : null,
        ];
    }

    /**
     * 获取单个用户信息
     *
     * @param  string $username
     *
     * @return mixed
     */
    public function one($username)
    {
        $result = $this->get("users/{$username}");

        return $result ? array_shift($result['entities']) : false;
    }

    /**
     * 删除单个用户
     *
     * @param  string $username
     *
     * @return boolean
     */
    public function remove($username)
    {
        $response = $this->delete("users/{$username}");

        return $response !== false;
    }

    /**
     * 批量删除用户, 可一次删除N个用户, N建议值在100~500之间.
     *
     * 需要通过返回值来确定哪些用户被删除了.
     *
     * @param  integer $count 删除个数
     *
     * @return array|boolean  成功删除用户信息列表
     */
    public function batchRemove($count = 100)
    {
        $result = $this->delete('users', ['query' => ['limit' => $count]]);

        return $result ? $result['entities'] : false;
    }

    /**
     * 重置用户密码
     *
     * @param string $username
     * @param string $password
     *
     * @return bool
     */
    public function resetPassword($username, $password)
    {
        $response = $this->put(
            "users/{$username}/password",
            [
                'body' => json_encode(['newpassword' => $password]),
            ]
        );

        return $response !== false;
    }

    /**
     * 更新用户昵称
     *
     * @param  string $username
     * @param  string $nickname
     *
     * @return boolean
     */
    public function updateNickname($username, $nickname)
    {
        $response = $this->put(
            "users/{$username}",
            [
                'body' => json_encode(['nickname' => $nickname]),
            ]
        );

        return $response ? !empty($response['entities']) : false;
    }

    /**
     * 为用户添加好友
     *
     * @param string $owner_name 用户名
     * @param string $friend_username 被添加为好友的用户名
     *
     * @return boolean
     */
    public function addFriend($owner_name, $friend_username)
    {
        $response = $this->post(
            "users/{$owner_name}/contacts/users/{$friend_username}"
        );

        return $response ? !empty($response['entities']) : false;
    }

    /**
     * 解除用户好友关系
     *
     * @param  string $owner_name
     * @param  string $friend_username
     *
     * @return boolean
     */
    public function removeFriend($owner_name, $friend_username)
    {
        $response = $this->post("users/{$owner_name}/contacts/users/{$friend_username}");

        return $response ? !empty($response['entities']) : false;
    }

    /**
     * 查看某个用户的好友
     *
     * @param  string $username
     *
     * @return array|boolean 好友用户名列表
     */
    public function friends($username)
    {
        $response = $this->get("users/{$username}/contacts/users");

        return $response ? $response['data'] : false;
    }

    /**
     * 查看某一个IM用户的黑名单
     *
     * @param  string $username
     *
     * @return array|boolean 黑名单中的用户名列表
     */
    public function blocks($username)
    {
        $response = $this->get("users/{$username}/blocks/users");

        return $response ? $response['data']: false;
    }

    /**
     * 为用户加入黑名单
     *
     * @param  string $username
     * @param  array $users 需要加入黑名单中的用户名
     *
     * @return array|boolean 已经加入到黑名单中的用户
     */
    public function block($username, $users)
    {
        $response = $this->post(
            "users/{$username}/blocks/users",
            [
                'usernames' => $users,
            ]
        );

        return $response ? $response['data'] : false;
    }

    /**
     * 解除黑名单
     *
     * @param  string $username
     * @param  string $target
     *
     * @return boolean
     */
    public function unblock($username, $target)
    {
        $response = $this->delete("users/{$username}/blocks/users/{$target}");

        return $response !== false;
    }

    /**
     * 查看用户是否在线
     *
     * @param  string $username
     *
     * @return boolean
     */
    public function isOnline($username)
    {
        $response = $this->get("users/{$username}/status");

        if (false === $response) {
            return false;
        }

        return 'online' === $response['data'][$username];
    }

    /**
     * 获取用户离线消息数
     *
     * @param  string $username
     *
     * @return integer
     */
    public function offlineMsgCount($username)
    {
        $response = $this->get("users/{$username}/offline_msg_count");

        if (false === $response) {
            return false;
        }

        return (int)$response['data'][$username];
    }

    /**
     * @param string $username
     * @param string $msg_id
     *
     * @return string|boolean delivered or undelivered
     */
    public function offlineMsgStatus($username, $msg_id)
    {
        $response = $this->get("users/{$username}/offline_msg_status/{$msg_id}");

        return $response ? $response['data'][$username] : false;
    }

    /**
     * 禁用账户
     *
     * @param  string $username
     *
     * @return boolean
     */
    public function disable($username)
    {
        $response = $this->post("users/{$username}/deactivate");

        return $response !== false;
    }

    /**
     * 解禁账户
     *
     * @param  string $username
     *
     * @return boolean
     */
    public function enable($username)
    {
        $response = $this->post("users/{$username}/activate");

        return $response !== false;
    }

    /**
     * 强制下线用户
     *
     * @param  string $username
     *
     * @return boolean
     */
    public function disconnect($username)
    {
        $response = $this->get("users/{$username}/disconnect");

        return $response ? $response['data']['result'] : false;
    }
}


1		<?php
2
3		namespace light\Easemob\Rest;
4
5		use light\Easemob\Support\Log;
6
7		/**
8		* User operation
9		*/
10		class User extends Rest
11		{
12		/**
13		* Register users
14		*
15		* 通过「授权注册」的方式注册用户.
16		*
17		* @param array $users
18		*
19		* [['username' => '123123', 'password' => 'password', 'nickname' => 'niamee']]
20		*
21		* @return array\|boolean The entities of registed user
22		*/
23	2	public function register($users)
24		{
25	2	$response = $this->post('users', $users);
26
27	2	return $response ? $response['entities'] : false;
28		}
29
30		/**
31		* Fetch all user records.
32		*
33		* @param string\|null $cursor
34		* @param integer $limit
35		*
36		* @return array\|boolean
37		*/
38		public function all($cursor = null, $limit = 20)
39		{
40		$result = $this->get('users', ['limit' => $limit, 'cursor' => $cursor]);
41
42		if (false === $result) {
43		return false;
44		}
45
46		return [
47		'items' => $result['entities'],
48		'cursor' => isset($result['cursor']) ? $result['cursor'] : null,
49		];
50		}
51
52		/**
53		* 获取单个用户信息
54		*
55		* @param string $username
56		*
57		* @return mixed
58		*/
59	2	public function one($username)
60		{
61	2	$result = $this->get("users/{$username}");
62
63	2	return $result ? array_shift($result['entities']) : false;
64		}
65
66		/**
67		* 删除单个用户
68		*
69		* @param string $username
70		*
71		* @return boolean
72		*/
73	3	public function remove($username)
74		{
75	3	$response = $this->delete("users/{$username}");
76
77	3	return $response !== false;
78		}
79
80		/**
81		* 批量删除用户, 可一次删除N个用户, N建议值在100~500之间.
82		*
83		* 需要通过返回值来确定哪些用户被删除了.
84		*
85		* @param integer $count 删除个数
86		*
87		* @return array\|boolean 成功删除用户信息列表
88		*/
89		public function batchRemove($count = 100)
90		{
91		$result = $this->delete('users', ['query' => ['limit' => $count]]);
92
93		return $result ? $result['entities'] : false;
94		}
95
96		/**
97		* 重置用户密码
98		*
99		* @param string $username
100		* @param string $password
101		*
102		* @return bool
103		*/
104		public function resetPassword($username, $password)
105		{
106		$response = $this->put(
107		"users/{$username}/password",
108		[
109		'body' => json_encode(['newpassword' => $password]),
110		]
111		);
112
113		return $response !== false;
114		}
115
116		/**
117		* 更新用户昵称
118		*
119		* @param string $username
120		* @param string $nickname
121		*
122		* @return boolean
123		*/
124		public function updateNickname($username, $nickname)
125		{
126		$response = $this->put(
127		"users/{$username}",
128		[
129		'body' => json_encode(['nickname' => $nickname]),
130		]
131		);
132
133		return $response ? !empty($response['entities']) : false;
134		}
135
136		/**
137		* 为用户添加好友
138		*
139		* @param string $owner_name 用户名
140		* @param string $friend_username 被添加为好友的用户名
141		*
142		* @return boolean
143		*/
144		public function addFriend($owner_name, $friend_username)
145		{
146		$response = $this->post(
147		"users/{$owner_name}/contacts/users/{$friend_username}"
148		);
149
150		return $response ? !empty($response['entities']) : false;
151		}
152
153		/**
154		* 解除用户好友关系
155		*
156		* @param string $owner_name
157		* @param string $friend_username
158		*
159		* @return boolean
160		*/
161		public function removeFriend($owner_name, $friend_username)
162		{
163		$response = $this->post("users/{$owner_name}/contacts/users/{$friend_username}");
164
165		return $response ? !empty($response['entities']) : false;
166		}
167
168		/**
169		* 查看某个用户的好友
170		*
171		* @param string $username
172		*
173		* @return array\|boolean 好友用户名列表
174		*/
175		public function friends($username)
176		{
177		$response = $this->get("users/{$username}/contacts/users");
178
179		return $response ? $response['data'] : false;
180		}
181
182		/**
183		* 查看某一个IM用户的黑名单
184		*
185		* @param string $username
186		*
187		* @return array\|boolean 黑名单中的用户名列表
188		*/
189		public function blocks($username)
190		{
191		$response = $this->get("users/{$username}/blocks/users");
192
193		return $response ? $response['data']: false;
194		}
195
196		/**
197		* 为用户加入黑名单
198		*
199		* @param string $username
200		* @param array $users 需要加入黑名单中的用户名
201		*
202		* @return array\|boolean 已经加入到黑名单中的用户
203		*/
204		public function block($username, $users)
205		{
206		$response = $this->post(
207		"users/{$username}/blocks/users",
208		[
209		'usernames' => $users,
210		]
211		);
212
213		return $response ? $response['data'] : false;
214		}
215
216		/**
217		* 解除黑名单
218		*
219		* @param string $username
220		* @param string $target
221		*
222		* @return boolean
223		*/
224		public function unblock($username, $target)
225		{
226		$response = $this->delete("users/{$username}/blocks/users/{$target}");
227
228		return $response !== false;
229		}
230
231		/**
232		* 查看用户是否在线
233		*
234		* @param string $username
235		*
236		* @return boolean
237		*/
238		public function isOnline($username)
239		{
240		$response = $this->get("users/{$username}/status");
241
242		if (false === $response) {
243		return false;
244		}
245
246		return 'online' === $response['data'][$username];
247		}
248
249		/**
250		* 获取用户离线消息数
251		*
252		* @param string $username
253		*
254		* @return integer
255		*/
256		public function offlineMsgCount($username)
257		{
258		$response = $this->get("users/{$username}/offline_msg_count");
259
260		if (false === $response) {
261		return false;
262		}
263
264		return (int)$response['data'][$username];
265		}
266
267		/**
268		* @param string $username
269		* @param string $msg_id
270		*
271		* @return string\|boolean delivered or undelivered
272		*/
273		public function offlineMsgStatus($username, $msg_id)
274		{
275		$response = $this->get("users/{$username}/offline_msg_status/{$msg_id}");
276
277		return $response ? $response['data'][$username] : false;
278		}
279
280		/**
281		* 禁用账户
282		*
283		* @param string $username
284		*
285		* @return boolean
286		*/
287		public function disable($username)
288		{
289		$response = $this->post("users/{$username}/deactivate");
290
291		return $response !== false;
292		}
293
294		/**
295		* 解禁账户
296		*
297		* @param string $username
298		*
299		* @return boolean
300		*/
301		public function enable($username)
302		{
303		$response = $this->post("users/{$username}/activate");
304
305		return $response !== false;
306		}
307
308		/**
309		* 强制下线用户
310		*
311		* @param string $username
312		*
313		* @return boolean
314		*/
315		public function disconnect($username)
316		{
317		$response = $this->get("users/{$username}/disconnect");
318
319		return $response ? $response['data']['result'] : false;
320		}
321		}
322

lichunqiang / easemob

Push — master ( 42b611...b70ab3 )

User::batchRemove() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like