Properties

$success

$success : boolean

是否请求成功

Type

boolean

$statusCode

$statusCode : integer

状态码

Type

integer

$reasonPhrase

$reasonPhrase : string

状态码原因短语

Type

string

$protocolVersion

$protocolVersion : string

Http协议版本

Type

string

$headers

$headers : array

Type

array

$headerNames

$headerNames : array

头名称数组 小写的头 => 第一次使用的头名称

Type

array

$body

$body : \Psr\Http\Message\StreamInterface

消息主体

Type

\Psr\Http\Message\StreamInterface

$cookies

$cookies : array

cookie数据

Type

array

$cookiesOrigin

$cookiesOrigin : array

cookie原始数据,包含expires、path、domain等

Type

array

$totalTime

$totalTime : double

请求总耗时,单位:秒

Type

double

$error

$error : string

错误信息

Type

string

$errno

$errno : integer

错误码

Type

integer

$streamId

$streamId : integer

Http2 streamId

Type

integer

Methods

__construct()

__construct(  $body = '',   $statusCode = \Yurun\Util\YurunHttp\Http\Psr7\Consts\StatusCode::OK,   $reasonPhrase = null) 

Parameters

$body
$statusCode
$reasonPhrase

getStatusCode()

getStatusCode() : integer

Gets the response status code.

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Returns

integer —

Status code.

withStatus()

withStatus(integer  $code, string  $reasonPhrase = '') : static

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

Parameters

integer $code

The 3-digit integer result code to set.

string $reasonPhrase

The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification.

Throws

\InvalidArgumentException

For invalid status code arguments.

Returns

static

getReasonPhrase()

getReasonPhrase() : string

Gets the response reason phrase associated with the status code.

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

Returns

string —

Reason phrase; must return an empty string if none present.

getProtocolVersion()

getProtocolVersion() : string

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Returns

string —

HTTP protocol version.

withProtocolVersion()

withProtocolVersion(string  $version) : static

Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new protocol version.

Parameters

string $version

HTTP protocol version

Returns

static

getHeaders()

getHeaders() : array

Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
    echo $name . ": " . implode(", ", $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
    foreach ($values as $value) {
        header(sprintf('%s: %s', $name, $value), false);
    }
}

While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.

Returns

array —

Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

hasHeader()

hasHeader(string  $name) : boolean

Checks if a header exists by the given case-insensitive name.

Parameters

string $name

Case-insensitive header field name.

Returns

boolean —

Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

getHeader()

getHeader(string  $name) : array<mixed,string>

Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given case-insensitive header name.

If the header does not appear in the message, this method MUST return an empty array.

Parameters

string $name

Case-insensitive header field name.

Returns

array<mixed,string> —

An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine()

getHeaderLine(string  $name) : string

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return an empty string.

Parameters

string $name

Case-insensitive header field name.

Returns

string —

A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

withHeader()

withHeader(string  $name, string|array<mixed,string>  $value) : static

Return an instance with the provided value replacing the specified header.

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new and/or updated header and value.

Parameters

string $name

Case-insensitive header field name.

string|array<mixed,string> $value

Header value(s).

Throws

\InvalidArgumentException

for invalid header names or values.

Returns

static

withAddedHeader()

withAddedHeader(string  $name, string|array<mixed,string>  $value) : static

Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new header and/or value.

Parameters

string $name

Case-insensitive header field name to add.

string|array<mixed,string> $value

Header value(s).

Throws

\InvalidArgumentException

for invalid header names or values.

Returns

static

withoutHeader()

withoutHeader(string  $name) : static

Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.

Parameters

string $name

Case-insensitive header field name to remove.

Returns

static

getBody()

getBody() : \Psr\Http\Message\StreamInterface

Gets the body of the message.

Returns

\Psr\Http\Message\StreamInterface —

Returns the body as a stream.

withBody()

withBody(\Psr\Http\Message\StreamInterface  $body) : static

Return an instance with the specified message body.

The body MUST be a StreamInterface object.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.

Parameters

\Psr\Http\Message\StreamInterface $body

Body.

Throws

\InvalidArgumentException

When the body is not valid.

Returns

static

getCookieParams()

getCookieParams() : array

Retrieve cookies.

Retrieves cookies sent by the client to the server.

The data MUST be compatible with the structure of the $_COOKIE superglobal.

Returns

array

getCookie()

getCookie(string  $name, mixed  $default = null) : mixed

获取cookie值

Parameters

string $name
mixed $default

Returns

mixed

withCookieOriginParams()

withCookieOriginParams(array  $cookiesOrigin) : static

设置cookie原始参数,包含expires、path、domain等

Parameters

array $cookiesOrigin

Returns

static

getCookieOriginParams()

getCookieOriginParams() : array

获取所有cookie原始参数,包含expires、path、domain等

Returns

array

getCookieOrigin()

getCookieOrigin(string  $name, mixed  $default = null) : string

获取cookie原始参数值,包含expires、path、domain等

Parameters

string $name
mixed $default

Returns

string

body()

body(string  $fromEncoding = null, string  $toEncoding = 'UTF-8') : string

获取返回的主体内容

Parameters

string $fromEncoding

请求返回数据的编码,如果不为空则进行编码转换

string $toEncoding

要转换到的编码,默认为UTF-8

Returns

string

xml()

xml(boolean  $assoc = false, string  $fromEncoding = null, string  $toEncoding = 'UTF-8') : mixed

获取xml格式内容

Parameters

boolean $assoc

为true时返回数组,为false时返回对象

string $fromEncoding

请求返回数据的编码,如果不为空则进行编码转换

string $toEncoding

要转换到的编码,默认为UTF-8

Returns

mixed

json()

json(boolean  $assoc = false, string  $fromEncoding = null, string  $toEncoding = 'UTF-8') : mixed

获取json格式内容

Parameters

boolean $assoc

为true时返回数组,为false时返回对象

string $fromEncoding

请求返回数据的编码,如果不为空则进行编码转换

string $toEncoding

要转换到的编码,默认为UTF-8

Returns

mixed

jsonp()

jsonp(boolean  $assoc = false, string  $fromEncoding = null, string  $toEncoding = 'UTF-8') : mixed

获取jsonp格式内容

Parameters

boolean $assoc

为true时返回数组,为false时返回对象

string $fromEncoding

请求返回数据的编码,如果不为空则进行编码转换

string $toEncoding

要转换到的编码,默认为UTF-8

Returns

mixed

httpCode()

httpCode() : integer

获取http状态码

Returns

integer

totalTime()

totalTime() : double

获取请求总耗时,单位:秒

Returns

double

getTotalTime()

getTotalTime() : double

获取请求总耗时,单位:秒

Returns

double

withTotalTime()

withTotalTime(float  $totalTime) : double

设置请求总耗时

Parameters

float $totalTime

Returns

double

error()

error() : string

返回错误信息

Returns

string

getError()

getError() : string

获取错误信息

Returns

string

withError()

withError(string  $error) : static

设置错误信息

Parameters

string $error

Returns

static

errno()

errno() : integer

返回错误代码

Returns

integer

getErrno()

getErrno() : integer

获取错误代码

Returns

integer

withErrno()

withErrno(integer  $errno) : static

设置错误代码

Parameters

integer $errno

Returns

static

withStreamId()

withStreamId(integer  $streamId) : static

设置 Http2 streamId

Parameters

integer $streamId

Returns

static

getStreamId()

getStreamId() : integer

Get http2 streamId

Returns

integer

setHeaders()

setHeaders(array  $headers) : static

在当前实例下设置头

Parameters

array $headers

Returns

static

setHeader()

setHeader(\Yurun\Util\YurunHttp\Http\Psr7\AbstractMessage  $object, string  $name, string  $value) : static

设置header

Parameters

\Yurun\Util\YurunHttp\Http\Psr7\AbstractMessage $object
string $name
string $value

Returns

static