PhalApi 2.21.6 类手册
\
PhalApi
Api
Cache
Config
Cookie
Crypt
RSA
Database
Error
Exception
Filter
Helper
Logger
Model
Request
Formatter
Response

\PhalApi\ResponseExplorerResponse

ExplorerResponse 控制台响应类

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

Summary

Methods
Properties
Constants
setRet()
setData()
setMsg()
setDebug()
addResult()
addHeaders()
output()
getStructureMapConfig()
adjustHttpStatus()
getResult()
getHeaders()
No public properties found
No constants found
mapStructure()
echoResult()
handleHeaders()
formatResult()
$ret
$data
$msg
$headers
$debug
$extraResult
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 — 调试信息

$extraResult

$extraResult : array

Type

array — 自定义额外的结果数据

Methods

setRet()

setRet(integer  $ret) : \PhalApi\Response

设置返回状态码

Parameters

integer $ret

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

Returns

\PhalApi\Response

setData()

setData(\PhalApi\array/string  $data) : \PhalApi\Response

设置返回数据

Parameters

\PhalApi\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

addResult()

addResult(string  $key, mixed  $value) : \PhalApi\Response

设置额外的根节点返回结果

Parameters

string $key

根节点键值，应避免和系统的 ret/msg/data/debug 重复
mixed $value

自定义数据

Returns

\PhalApi\Response

addHeaders()

addHeaders(string  $key, string  $content)

添加报文头部

Parameters

string $key

名称
string $content

内容

output()

output()

结果输出

getStructureMapConfig()

getStructureMapConfig()

获取返回字段映射配置，在线接口文档或外部需要展示的场景也需要使用，故用public

adjustHttpStatus()

adjustHttpStatus()

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

getResult()

getResult()

获取返回结果

getHeaders()

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

获取头部

Parameters

string $key

头部的名称

Returns

\PhalApi\string/array —

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

mapStructure()

mapStructure(  $rs)

结构体字段映射

Parameters

$rs

echoResult()

echoResult(  $rs)

Parameters

$rs

handleHeaders()

handleHeaders(  $headers)

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

Parameters

$headers

formatResult()

formatResult(array  $result)

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

Parameters

array $result

待返回的结果数据