Client.php
10.4 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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
<?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.
*/
namespace EasyWeChat\OfficialAccount\Card;
use EasyWeChat\Kernel\BaseClient;
use EasyWeChat\Kernel\Traits\InteractsWithCache;
/**
* Class Client.
*
* @author overtrue <i@overtrue.me>
*/
class Client extends BaseClient
{
use InteractsWithCache;
/**
* @var string
*/
protected $url;
/**
* Ticket cache key.
*
* @var string
*/
protected $ticketCacheKey;
/**
* Ticket cache prefix.
*
* @var string
*/
protected $ticketCachePrefix = 'easywechat.official_account.card.api_ticket.';
/**
* 获取卡券颜色.
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function colors()
{
return $this->httpGet('card/getcolors');
}
/**
* 卡券开放类目查询接口.
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function categories()
{
return $this->httpGet('card/getapplyprotocol');
}
/**
* 创建卡券.
*
* @param string $cardType
* @param array $attributes
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function create($cardType = 'member_card', array $attributes)
{
$params = [
'card' => [
'card_type' => strtoupper($cardType),
strtolower($cardType) => $attributes,
],
];
return $this->httpPostJson('card/create', $params);
}
/**
* 查看卡券详情.
*
* @param string $cardId
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function get($cardId)
{
$params = [
'card_id' => $cardId,
];
return $this->httpPostJson('card/get', $params);
}
/**
* 批量查询卡列表.
*
* @param int $offset
* @param int $count
* @param string $statusList
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function list($offset = 0, $count = 10, $statusList = 'CARD_STATUS_VERIFY_OK')
{
$params = [
'offset' => $offset,
'count' => $count,
'status_list' => $statusList,
];
return $this->httpPostJson('card/batchget', $params);
}
/**
* 更改卡券信息接口 and 设置跟随推荐接口.
*
* @param string $cardId
* @param string $type
* @param array $attributes
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function update($cardId, $type, array $attributes = [])
{
$card = [];
$card['card_id'] = $cardId;
$card[strtolower($type)] = $attributes;
return $this->httpPostJson('card/update', $card);
}
/**
* 删除卡券接口.
*
* @param string $cardId
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function delete($cardId)
{
$params = [
'card_id' => $cardId,
];
return $this->httpPostJson('card/delete', $params);
}
/**
* 创建二维码.
*
* @param array $cards
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function createQrCode(array $cards)
{
return $this->httpPostJson('card/qrcode/create', $cards);
}
/**
* ticket 换取二维码图片.
*
* @param string $ticket
*
* @return array
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getQrCode($ticket)
{
$baseUri = 'https://mp.weixin.qq.com/cgi-bin/showqrcode';
$params = [
'ticket' => $ticket,
];
$response = $this->requestRaw($baseUri, 'GET', $params);
return [
'status' => $response->getStatusCode(),
'reason' => $response->getReasonPhrase(),
'headers' => $response->getHeaders(),
'body' => strval($response->getBody()),
'url' => $baseUri.'?'.http_build_query($params),
];
}
/**
* 通过ticket换取二维码 链接.
*
* @param string $ticket
*
* @return string
*/
public function getQrCodeUrl($ticket)
{
return sprintf('https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=%s', $ticket);
}
/**
* 创建货架接口.
*
* @param string $banner
* @param string $pageTitle
* @param bool $canShare
* @param string $scene [SCENE_NEAR_BY 附近,SCENE_MENU 自定义菜单,SCENE_QRCODE 二维码,SCENE_ARTICLE 公众号文章,
* SCENE_H5 h5页面,SCENE_IVR 自动回复,SCENE_CARD_CUSTOM_CELL 卡券自定义cell]
* @param array $cardList
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function createLandingPage($banner, $pageTitle, $canShare, $scene, $cardList)
{
$params = [
'banner' => $banner,
'page_title' => $pageTitle,
'can_share' => $canShare,
'scene' => $scene,
'card_list' => $cardList,
];
return $this->httpPostJson('card/landingpage/create', $params);
}
/**
* 图文消息群发卡券.
*
* @param string $cardId
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getHtml($cardId)
{
$params = [
'card_id' => $cardId,
];
return $this->httpPostJson('card/mpnews/gethtml', $params);
}
/**
* 设置测试白名单.
*
* @param array $openids
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function setTestWhitelist($openids)
{
$params = [
'openid' => $openids,
];
return $this->httpPostJson('card/testwhitelist/set', $params);
}
/**
* 设置测试白名单(by username).
*
* @param array $usernames
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function setTestWhitelistByName(array $usernames)
{
$params = [
'username' => $usernames,
];
return $this->httpPostJson('card/testwhitelist/set', $params);
}
/**
* 获取用户已领取卡券接口.
*
* @param string $openid
* @param string $cardId
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getUserCards($openid, $cardId = '')
{
$params = [
'openid' => $openid,
'card_id' => $cardId,
];
return $this->httpPostJson('card/user/getcardlist', $params);
}
/**
* 设置微信买单接口.
* 设置买单的 card_id 必须已经配置了门店,否则会报错.
*
* @param string $cardId
* @param bool $isOpen
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function setPayCell($cardId, $isOpen = true)
{
$params = [
'card_id' => $cardId,
'is_open' => $isOpen,
];
return $this->httpPostJson('card/paycell/set', $params);
}
/**
* 设置自助核销接口
* 设置买单的 card_id 必须已经配置了门店,否则会报错.
*
* @param string $cardId
* @param bool $isOpen
* @param bool $verifyCod
* @param bool $remarkAmount
*
* @return mixed
*/
public function setPayConsumeCell($cardId, $isOpen = true, $verifyCod = false, $remarkAmount = false)
{
$params = [
'card_id' => $cardId,
'is_open' => $isOpen,
'need_verify_cod' => $verifyCod,
'need_remark_amount' => $remarkAmount,
];
return $this->httpPostJson('card/selfconsumecell/set', $params);
}
/**
* 增加库存.
*
* @param string $cardId
* @param int $amount
*
* @return \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string
*/
public function increaseStock($cardId, $amount)
{
return $this->updateStock($cardId, $amount, 'increase');
}
/**
* 减少库存.
*
* @param string $cardId
* @param int $amount
*
* @return \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string
*/
public function reduceStock($cardId, $amount)
{
return $this->updateStock($cardId, $amount, 'reduce');
}
/**
* 修改库存接口.
*
* @param string $cardId
* @param int $amount
* @param string $action
*
* @return mixed
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
protected function updateStock($cardId, $amount, $action = 'increase')
{
$key = 'increase' === $action ? 'increase_stock_value' : 'reduce_stock_value';
$params = [
'card_id' => $cardId,
$key => abs($amount),
];
return $this->httpPostJson('card/modifystock', $params);
}
}