-
Notifications
You must be signed in to change notification settings - Fork 15
/
Response.php
283 lines (243 loc) · 7.44 KB
/
Response.php
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
<?php
namespace PhalApi;
/**
* Response 响应类
*
* - 拥有各种结果返回状态 ,以及对返回结果 的格式化
* - 其中:200成功,400非法请求,500服务器错误
*
* @package PhalApi\Response
* @license http://www.phalapi.net/license GPL 协议
* @link http://www.phalapi.net/
* @author dogstar <chanzonghuang@gmail.com> 2014-10-02
*/
abstract class Response {
/**
* @var int $ret 返回状态码,其中:200成功,400非法请求,500服务器错误
*/
protected $ret = 200;
/**
* @var array 待返回给客户端的数据
*/
protected $data = array();
/**
* @var string $msg 错误返回信息
*/
protected $msg = '';
/**
* @var array $headers 响应报文头部
*/
protected $headers = array();
/**
* @var array $debug 调试信息
*/
protected $debug = array();
/**
* @var array 自定义额外的结果数据
*/
protected $extraResult = array();
/** ------------------ setter ------------------ **/
/**
* 设置返回状态码
* @param int $ret 返回状态码,其中:200成功,400非法请求,500服务器错误
* @return Response
*/
public function setRet($ret) {
$this->ret = $ret;
return $this;
}
/**
* 设置返回数据
* @param array/string $data 待返回给客户端的数据,建议使用数组,方便扩展升级
* @return Response
*/
public function setData($data) {
$this->data = $data;
return $this;
}
/**
* 设置错误信息
* @param string $msg 错误信息
* @return Response
*/
public function setMsg($msg) {
$this->msg = $msg;
return $this;
}
/**
* 设置调试信息
* @param string $key 键值标识
* @param mixed $value 调试数据
* @return Response
*/
public function setDebug($key, $value) {
if (DI()->debug) {
$this->debug[$key] = $value;
}
return $this;
}
/**
* 设置额外的根节点返回结果
* @param string $key 根节点键值,应避免和系统的 ret/msg/data/debug 重复
* @param mixed $value 自定义数据
* @return Response
*/
public function addResult($key, $value) {
$this->extraResult[$key] = $value;
return $this;
}
/**
* 添加报文头部
* @param string $key 名称
* @param string $content 内容
*/
public function addHeaders($key, $content) {
$this->headers[$key] = $content;
}
/** ------------------ 结果输出 ------------------ **/
/**
* 结果输出
*/
public function output() {
// Step 1. 头部header处理
$this->handleHeaders($this->headers);
// Step 2. 获取数据结果
$rs = $this->getResult();
// Step 3. 结构体字段映射
$rs = $this->mapStructure($rs);
// Step 4. 序列化结果
$rs = $this->formatResult($rs);
// Step 5. 返回输出结果
$this->echoResult($rs);
}
/**
* 结构体字段映射
*/
protected function mapStructure($rs) {
$map = $this->getStructureMapConfig();
foreach ($rs as $key => $val) {
if (!isset($map[$key]) || $key == $map[$key]) {
continue;
}
$rs[$map[$key]] = $val;
unset($rs[$key]);
}
return $rs;
}
/**
* 获取返回字段映射配置,在线接口文档或外部需要展示的场景也需要使用,故用public
*/
public function getStructureMapConfig() {
$structureMap = \PhalApi\DI()->config->get('sys.response.structure_map', array());
$map = array(
'ret' => 'ret',
'data' => 'data',
'msg' => 'msg',
'debug' => 'debug',
);
foreach ($structureMap as $oldKey => $newKey) {
if (!isset($map[$oldKey]) || empty($newKey)) {
continue;
}
$map[$oldKey] = $newKey;
}
return $map;
}
protected function echoResult($rs) {
echo $rs;
}
/** ------------------ getter ------------------ **/
/**
* 根据状态码调整Http响应状态码
*/
public function adjustHttpStatus() {
$httpStatus = array(
100 => 'Continue',
101 => 'Switching Protocols',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Time-out',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Large',
415 => 'Unsupported Media Type',
416 => 'Requested range not satisfiable',
417 => 'Expectation Failed',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Time-out',
505 => 'HTTP Version not supported',
);
$protocol = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
$str = "{$protocol} {$this->ret} " . (isset($httpStatus[$this->ret]) ? $httpStatus[$this->ret] : 'Unknown Http Status Code');
@header($str);
return $this;
}
/**
* 获取返回结果
*/
public function getResult() {
$rs = array(
'ret' => $this->ret,
'data' => is_array($this->data) && empty($this->data) ? (object)$this->data : $this->data, // # 67 优化
'msg' => $this->msg,
);
if (!empty($this->debug)) {
$rs['debug'] = $this->debug;
}
// 合并自定义结果
$rs = array_merge($rs, $this->extraResult);
return $rs;
}
/**
* 获取头部
*
* @param string $key 头部的名称
* @return string/array 对应的内容,不存在时返回NULL,$key为NULL时返回全部
*/
public function getHeaders($key = NULL) {
if ($key === NULL) {
return $this->headers;
}
return isset($this->headers[$key]) ? $this->headers[$key] : NULL;
}
/** ------------------ 内部方法 ------------------ **/
protected function handleHeaders($headers) {
foreach ($headers as $key => $content) {
@header($key . ': ' . $content);
}
}
/**
* 格式化需要输出返回的结果
*
* @param array $result 待返回的结果数据
*
* @see Response::getResult()
*/
abstract protected function formatResult($result);
}