\swoole_http_response

class swoole_http_response

Summary

Methods
Properties
Constants
cookie()
rawcookie()
status()
gzip()
header()
write()
end()
sendfile()
$cookie
$header
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$cookie

$cookie : array

http response的缓存

Type

array

$header

$header : array|string

http response头

Type

array|string

Methods

cookie()

cookie(string  $name, string  $value = '', integer  $expires, string  $path = '/', string  $domain = '', boolean  $secure = false, boolean  $httponly = false) : void

cookie 设置 HTTP 响应的 cookie 信息。此方法参数与 PHP 的 setcookie 完全一致。

Parameters

string $name

key 的名称,小写

string $value

[optional] $name 对应的 value 值

integer $expires

[optional] 过期时间

string $path

[optional]

string $domain

[optional]

boolean $secure

[optional]

boolean $httponly

[optional]

rawcookie()

rawcookie(  $name,   $value = null,   $expires = null,   $path = null,   $domain = null,   $secure = null,   $httponly = null) : 

rawcookie

Parameters

$name
$value

[optional]

$expires

[optional]

$path

[optional]

$domain

[optional]

$secure

[optional]

$httponly

[optional]

Returns

status()

status(integer  $http_code) : void

status 发送 Http 状态码

Parameters

integer $http_code

必须为合法的 HttpCode,如200, 502, 301, 404等,否则会报错 必须在 $response->end 之前执行 status

gzip()

gzip(integer  $compress_level = 1) : 

gzip 启用Http GZIP压缩。压缩可以减小HTML内容的尺寸,有效节省网络带宽,提高响应时间。 必须在write/end发送内容之前执行gzip,否则会抛出错误。

Parameters

integer $compress_level

[optional] 压缩等级,范围是1-9,等级越高压缩后的尺寸越小,但CPU消耗更多。默认为1

Returns

header()

header(string  $key, string  $value, boolean  $ucwords = true) : 

header 设置 HTTP 响应的 Header 信息。 $key必须完全符合Http的约定,每个单词首字母大写,不得包含中文,下划线或者其他特殊字符 $value必须填写,示例: $responser->header('Content-Type', 'image/jpeg');

Parameters

string $key

Http头的Key

string $value

Http头的Value

boolean $ucwords

[optional]

Returns

write()

write(string  $content) : boolean

write 启用 Http Chunk 分段向浏览器发送相应内容。关于 Http Chunk 可以参考 Http 协议标准文档。 $content 要发送的数据内容,最大长度不得超过2M 使用 write 分段发送数据后,end 方法将不接受任何参数 调用 end 方法后会发送一个长度为 0 的 Chunk 表示数据传输完毕

Parameters

string $content

Returns

boolean —

成功返回 true,失败返回 false

end()

end(string  $content = null) : boolean

end 发送Http响应体,并结束请求处理。

Parameters

string $content

[optional] 向客户端浏览器发送的 html 内容

Returns

boolean —

成功返回 true,失败返回 false

sendfile()

sendfile(string  $filename) : boolean

sendfile 发送文件到浏览器。

Parameters

string $filename

要发送的文件名称

Returns

boolean —

成功返回 true,失败返回 false