User.php
4.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?php
/*
* This file is part of the overtrue/wechat.
*
* (c) overtrue <i@overtrue.me>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
/**
* User.php.
*
* @author overtrue <i@overtrue.me>
* @copyright 2015 overtrue <i@overtrue.me>
*
* @see https://github.com/overtrue
* @see http://overtrue.me
*/
namespace EasyWeChat\User;
use EasyWeChat\Core\AbstractAPI;
/**
* Class User.
*/
class User extends AbstractAPI
{
const API_GET = 'https://api.weixin.qq.com/cgi-bin/user/info';
const API_BATCH_GET = 'https://api.weixin.qq.com/cgi-bin/user/info/batchget';
const API_LIST = 'https://api.weixin.qq.com/cgi-bin/user/get';
const API_GROUP = 'https://api.weixin.qq.com/cgi-bin/groups/getid';
const API_REMARK = 'https://api.weixin.qq.com/cgi-bin/user/info/updateremark';
const API_OAUTH_GET = 'https://api.weixin.qq.com/sns/userinfo';
const API_GET_BLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist';
const API_BATCH_BLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/batchblacklist';
const API_BATCH_UNBLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/batchunblacklist';
/**
* Fetch a user by open id.
*
* @param string $openId
* @param string $lang
*
* @return \EasyWeChat\Support\Collection
*/
public function get($openId, $lang = 'zh_CN')
{
$params = [
'openid' => $openId,
'lang' => $lang,
];
return $this->parseJSON('get', [self::API_GET, $params]);
}
/**
* Batch get users.
*
* @param array $openIds
* @param string $lang
*
* @return \EasyWeChat\Support\Collection
*/
public function batchGet(array $openIds, $lang = 'zh_CN')
{
$params = [];
$params['user_list'] = array_map(function ($openId) use ($lang) {
return [
'openid' => $openId,
'lang' => $lang,
];
}, $openIds);
return $this->parseJSON('json', [self::API_BATCH_GET, $params]);
}
/**
* List users.
*
* @param string $nextOpenId
*
* @return \EasyWeChat\Support\Collection
*/
public function lists($nextOpenId = null)
{
$params = ['next_openid' => $nextOpenId];
return $this->parseJSON('get', [self::API_LIST, $params]);
}
/**
* Set user remark.
*
* @param string $openId
* @param string $remark
*
* @return \EasyWeChat\Support\Collection
*/
public function remark($openId, $remark)
{
$params = [
'openid' => $openId,
'remark' => $remark,
];
return $this->parseJSON('json', [self::API_REMARK, $params]);
}
/**
* Get user's group id.
*
* @param string $openId
*
* @return \EasyWeChat\Support\Collection
*/
public function group($openId)
{
return $this->getGroup($openId);
}
/**
* Get user's group.
*
* @param string $openId
*
* @return \EasyWeChat\Support\Collection
*/
public function getGroup($openId)
{
$params = ['openid' => $openId];
return $this->parseJSON('json', [self::API_GROUP, $params]);
}
/**
* Get black list.
*
* @param string|null $beginOpenid
*
* @return \EasyWeChat\Support\Collection
*/
public function blacklist($beginOpenid = null)
{
$params = ['begin_openid' => $beginOpenid];
return $this->parseJSON('json', [self::API_GET_BLACK_LIST, $params]);
}
/**
* Batch block user.
*
* @param array $openidList
*
* @return \EasyWeChat\Support\Collection
*/
public function batchBlock(array $openidList)
{
$params = ['openid_list' => $openidList];
return $this->parseJSON('json', [self::API_BATCH_BLACK_LIST, $params]);
}
/**
* Batch unblock user.
*
* @param array $openidList
*
* @return \EasyWeChat\Support\Collection
*/
public function batchUnblock(array $openidList)
{
$params = ['openid_list' => $openidList];
return $this->parseJSON('json', [self::API_BATCH_UNBLACK_LIST, $params]);
}
}