PhalApi docs - 1.4.2
\

\PhalApi_Response_Json

PhalApi_Response_Json JSON响应类

  • 拥有各种结果返回状态 ，以及对返回结果 的格式化
  • 其中：200成功，400非法请求，500服务器错误

Summary

Methods
Properties
Constants
setRet()
setData()
setMsg()
setDebug()
addHeaders()
output()
adjustHttpStatus()
getResult()
getHeaders()
__construct()
No public properties found
No constants found
handleHeaders()
formatResult()
$ret
$data
$msg
$headers
$debug
$options
N/A
No private methods found
No private properties found
N/A

Properties

$ret

$ret : integer

Type

integer — 返回状态码，其中：200成功，400非法请求，500服务器错误

$data

$data : array

Type

array — 待返回给客户端的数据

$msg

$msg : string

Type

string — 错误返回信息

$headers

$headers : array

Type

array — 响应报文头部

$debug

$debug : array

Type

array — 调试信息

$options

$options :

Type

Methods

setRet()

setRet(integer  $ret) : \PhalApi_Response

设置返回状态码

Parameters

integer $ret

返回状态码，其中：200成功，400非法请求，500服务器错误

Returns

\PhalApi_Response

setData()

setData(\array/string  $data) : \PhalApi_Response

设置返回数据

Parameters

\array/string $data

待返回给客户端的数据，建议使用数组，方便扩展升级

Returns

\PhalApi_Response

setMsg()

setMsg(string  $msg) : \PhalApi_Response

设置错误信息

Parameters

string $msg

错误信息

Returns

\PhalApi_Response

setDebug()

setDebug(string  $key, mixed  $value) : \PhalApi_Response

设置调试信息

Parameters

string $key

键值标识
mixed $value

调试数据

Returns

\PhalApi_Response

addHeaders()

addHeaders(string  $key, string  $content)

添加报文头部

Parameters

string $key

名称
string $content

内容

output()

output()

结果输出

adjustHttpStatus()

adjustHttpStatus()

根据状态码调整Http响应状态码

getResult()

getResult()

getHeaders()

getHeaders(string  $key = NULL) : \string/array

获取头部

Parameters

string $key

头部的名称

Returns

\string/array —

对应的内容，不存在时返回NULL，$key为NULL时返回全部

__construct()

__construct(  $options)

Parameters

$options

handleHeaders()

handleHeaders(  $headers)

------------------ 内部方法 ------------------ *

Parameters

$headers

formatResult()

formatResult(array  $result)

格式化需要输出返回的结果

Parameters

array $result

待返回的结果数据