AccessToken.php
5.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
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
<?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.
*/
/**
* AccessToken.php.
*
* @author overtrue <i@overtrue.me>
* @copyright 2015 overtrue <i@overtrue.me>
*
* @see https://github.com/overtrue
* @see http://overtrue.me
*/
namespace EasyWeChat\Core;
use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Cache\FilesystemCache;
use EasyWeChat\Core\Exceptions\HttpException;
/**
* Class AccessToken.
*/
class AccessToken
{
/**
* App ID.
*
* @var string
*/
protected $appId;
/**
* App secret.
*
* @var string
*/
protected $secret;
/**
* Cache.
*
* @var Cache
*/
protected $cache;
/**
* Cache Key.
*
* @var string
*/
protected $cacheKey;
/**
* Http instance.
*
* @var Http
*/
protected $http;
/**
* Query name.
*
* @var string
*/
protected $queryName = 'access_token';
/**
* Response Json key name.
*
* @var string
*/
protected $tokenJsonKey = 'access_token';
/**
* Cache key prefix.
*
* @var string
*/
protected $prefix = 'easywechat.common.access_token.';
// API
const API_TOKEN_GET = 'https://api.weixin.qq.com/cgi-bin/token';
/**
* Constructor.
*
* @param string $appId
* @param string $secret
* @param \Doctrine\Common\Cache\Cache $cache
*/
public function __construct($appId, $secret, Cache $cache = null)
{
$this->appId = $appId;
$this->secret = $secret;
$this->cache = $cache;
}
/**
* Get token from WeChat API.
*
* @param bool $forceRefresh
*
* @return string
*/
public function getToken($forceRefresh = false)
{
$cacheKey = $this->getCacheKey();
$cached = $this->getCache()->fetch($cacheKey);
if ($forceRefresh || empty($cached)) {
$token = $this->getTokenFromServer();
// XXX: T_T... 7200 - 1500
$this->getCache()->save($cacheKey, $token[$this->tokenJsonKey], $token['expires_in'] - 1500);
return $token[$this->tokenJsonKey];
}
return $cached;
}
/**
* 设置自定义 token.
*
* @param string $token
* @param int $expires
*
* @return $this
*/
public function setToken($token, $expires = 7200)
{
$this->getCache()->save($this->getCacheKey(), $token, $expires - 1500);
return $this;
}
/**
* Return the app id.
*
* @return string
*/
public function getAppId()
{
return $this->appId;
}
/**
* Return the secret.
*
* @return string
*/
public function getSecret()
{
return $this->secret;
}
/**
* Set cache instance.
*
* @param \Doctrine\Common\Cache\Cache $cache
*
* @return AccessToken
*/
public function setCache(Cache $cache)
{
$this->cache = $cache;
return $this;
}
/**
* Return the cache manager.
*
* @return \Doctrine\Common\Cache\Cache
*/
public function getCache()
{
return $this->cache ?: $this->cache = new FilesystemCache(sys_get_temp_dir());
}
/**
* Set the query name.
*
* @param string $queryName
*
* @return $this
*/
public function setQueryName($queryName)
{
$this->queryName = $queryName;
return $this;
}
/**
* Return the query name.
*
* @return string
*/
public function getQueryName()
{
return $this->queryName;
}
/**
* Return the API request queries.
*
* @return array
*/
public function getQueryFields()
{
return [$this->queryName => $this->getToken()];
}
/**
* Get the access token from WeChat server.
*
* @throws \EasyWeChat\Core\Exceptions\HttpException
*
* @return string
*/
public function getTokenFromServer()
{
$params = [
'appid' => $this->appId,
'secret' => $this->secret,
'grant_type' => 'client_credential',
];
$http = $this->getHttp();
$token = $http->parseJSON($http->get(self::API_TOKEN_GET, $params));
if (empty($token[$this->tokenJsonKey])) {
throw new HttpException('Request AccessToken fail. response: '.json_encode($token, JSON_UNESCAPED_UNICODE));
}
return $token;
}
/**
* Return the http instance.
*
* @return \EasyWeChat\Core\Http
*/
public function getHttp()
{
return $this->http ?: $this->http = new Http();
}
/**
* Set the http instance.
*
* @param \EasyWeChat\Core\Http $http
*
* @return $this
*/
public function setHttp(Http $http)
{
$this->http = $http;
return $this;
}
/**
* Set the access token prefix.
*
* @param string $prefix
*
* @return $this
*/
public function setPrefix($prefix)
{
$this->prefix = $prefix;
return $this;
}
/**
* Set access token cache key.
*
* @param string $cacheKey
*
* @return $this
*/
public function setCacheKey($cacheKey)
{
$this->cacheKey = $cacheKey;
return $this;
}
/**
* Get access token cache key.
*
* @return string $this->cacheKey
*/
public function getCacheKey()
{
if (is_null($this->cacheKey)) {
return $this->prefix.$this->appId;
}
return $this->cacheKey;
}
}