Device.php
4.8 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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?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.
*/
/**
* Device.php.
*
* @author allen05ren <allen05ren@outlook.com>
* @copyright 2016 overtrue <i@overtrue.me>
*
* @see https://github.com/overtrue
* @see http://overtrue.me
*/
namespace EasyWeChat\ShakeAround;
use EasyWeChat\Core\AbstractAPI;
use EasyWeChat\Core\Exceptions\InvalidArgumentException;
/**
* Class Device.
*/
class Device extends AbstractAPI
{
const API_DEVICE_APPLYID = 'https://api.weixin.qq.com/shakearound/device/applyid';
const API_DEVICE_APPLYSTATUS = 'https://api.weixin.qq.com/shakearound/device/applystatus';
const API_DEVICE_UPDATE = 'https://api.weixin.qq.com/shakearound/device/update';
const API_DEVICE_BINDLOCATION = 'https://api.weixin.qq.com/shakearound/device/bindlocation';
const API_DEVICE_SEARCH = 'https://api.weixin.qq.com/shakearound/device/search';
/**
* Apply device ids.
*
* @param int $quantity
* @param string $reason
* @param string $comment
* @param int $poiId
*
* @return \EasyWeChat\Support\Collection
*/
public function apply($quantity, $reason, $comment = '', $poiId = null)
{
$params = [
'quantity' => intval($quantity),
'apply_reason' => $reason,
];
if (!empty($comment)) {
$params['comment'] = $comment;
}
if (!is_null($poiId)) {
$params['poi_id'] = intval($poiId);
}
return $this->parseJSON('json', [self::API_DEVICE_APPLYID, $params]);
}
/**
* Get audit status.
*
* @param int $applyId
*
* @return \EasyWeChat\Support\Collection
*/
public function getStatus($applyId)
{
$params = [
'apply_id' => intval($applyId),
];
return $this->parseJSON('json', [self::API_DEVICE_APPLYSTATUS, $params]);
}
/**
* Update a device comment.
*
* @param array $deviceIdentifier
* @param string $comment
*
* @return \EasyWeChat\Support\Collection
*/
public function update(array $deviceIdentifier, $comment)
{
$params = [
'device_identifier' => $deviceIdentifier,
'comment' => $comment,
];
return $this->parseJSON('json', [self::API_DEVICE_UPDATE, $params]);
}
/**
* Bind location for device.
*
* @param array $deviceIdentifier
* @param int $poiId
* @param int $type
* @param string $poiAppid
*
* @return \EasyWeChat\Support\Collection
*
* @throws InvalidArgumentException
*/
public function bindLocation(array $deviceIdentifier, $poiId, $type = 1, $poiAppid = null)
{
$params = [
'device_identifier' => $deviceIdentifier,
'poi_id' => intval($poiId),
];
if (2 === $type) {
if (is_null($poiAppid)) {
throw new InvalidArgumentException('If value of argument #3 is 2, argument #4 is required.');
}
$params['type'] = 2;
$params['poi_appid'] = $poiAppid;
}
return $this->parseJSON('json', [self::API_DEVICE_BINDLOCATION, $params]);
}
/**
* Fetch batch of devices by deviceIds.
*
* @param array $deviceIdentifiers
*
* @return \EasyWeChat\Support\Collection
*/
public function fetchByIds(array $deviceIdentifiers)
{
$params = [
'type' => 1,
'device_identifiers' => $deviceIdentifiers,
];
return $this->fetch($params);
}
/**
* Pagination to fetch batch of devices.
*
* @param int $lastSeen
* @param int $count
*
* @return \EasyWeChat\Support\Collection
*/
public function pagination($lastSeen, $count)
{
$params = [
'type' => 2,
'last_seen' => intval($lastSeen),
'count' => intval($count),
];
return $this->fetch($params);
}
/**
* Fetch batch of devices by applyId.
*
* @param int $applyId
* @param int $lastSeen
* @param int $count
*
* @return \EasyWeChat\Support\Collection
*/
public function fetchByApplyId($applyId, $lastSeen, $count)
{
$params = [
'type' => 3,
'apply_id' => intval($applyId),
'last_seen' => intval($lastSeen),
'count' => intval($count),
];
return $this->fetch($params);
}
/**
* Fetch batch of devices.
*
* @param array $params
*
* @return \EasyWeChat\Support\Collection
*/
private function fetch($params)
{
return $this->parseJSON('json', [self::API_DEVICE_SEARCH, $params]);
}
}