\PhalApi\ResponseHtmlResponse

HtmlResponse 响应类

支持页面渲染返回输出

\PhalApi\DI()->response = new \PhalApi\Response\HtmlResponse(); // 重新注册

Summary

Methods

Properties

Constants

__construct()
setRet()
setData()
setMsg()
setDebug()
addResult()
addHeaders()
output()
getStructureMapConfig()
adjustHttpStatus()
getResult()
getHeaders()
fetch()
assign()
setThemes()
load()

No public properties found

No constants found

formatResult()
mapStructure()
echoResult()
handleHeaders()

$options
$ret
$data
$msg
$headers
$debug
$extraResult
$namespace
$themes
$name
$param
$ext

N/A

path()

No private properties found

N/A

File: kernal/src/Response/HtmlResponse.php
Package: Default
Class hierarchy: \PhalApi\Response

\PhalApi\Response\JsonResponse

\PhalApi\Response\HtmlResponse

Properties

$options

$options : integer

Type

integer — JSON常量组合的二进制掩码

$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 — 自定义额外的结果数据

$namespace

$namespace :

Type

$themes

$themes :

Type

$name

$name :

Type

$param

$param :

Type

$ext

$ext :

Type

Methods

__construct()

__construct(  $themes = 'Default',   $ext = '.php')

Parameters

	$themes
	$ext

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时返回全部

fetch()

fetch(  $k,   $v)

注入单个变量

Parameters

	$k
	$v

assign()

assign(array  $param = array())

注入数组变量

Parameters

array

$param

参数 $K => $v

setThemes()

setThemes(  $themes)

设置模板主题

Parameters

$themes

load()

load(string  $name, array  $param = array(), boolean  $isOutput = true) : false|string|null

装载模板

Parameters

string	$name	html文件名称
array	$param
boolean	$isOutput	是否直接输出模板内容

Throws

\Exception

Returns

false|string|null

formatResult()

formatResult(array  $result) : false|string

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

Parameters

array

$result

待返回的结果数据

Throws

\Exception

Returns

false|string

mapStructure()

mapStructure(  $rs)

结构体字段映射

Parameters

$rs

echoResult()

echoResult(  $rs)

Parameters

$rs

handleHeaders()

handleHeaders(  $headers)

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

Parameters

$headers

path()

path(string  $name = '') : string

获取模板路径

Parameters

string

$name

Returns

string