Methods

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 = '') : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

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) : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

getHeaders()

getHeaders() : array<mixed,string[]>

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<mixed,string[]> —

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) : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

withAddedHeader()

withAddedHeader(string  $name, string|array<mixed,string>  $value) : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

withoutHeader()

withoutHeader(string  $name) : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

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) : \Imi\Server\Http\Message\Response

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

\Imi\Server\Http\Message\Response

getInstance()

getInstance(\Imi\Server\Base  $server, \Swoole\Http\Response  $response) : \Imi\Server\Http\Message\Response

获取实例对象

Parameters

\Imi\Server\Base $server
\Swoole\Http\Response $response

Returns

\Imi\Server\Http\Message\Response

withCookie()

withCookie(string  $key, string  $value, integer  $expire, string  $path = '/', string  $domain = '', boolean  $secure = false, boolean  $httponly = false) : \Imi\Server\Http\Message\Response

设置cookie

Parameters

string $key
string $value
integer $expire
string $path
string $domain
boolean $secure
boolean $httponly

Returns

\Imi\Server\Http\Message\Response

getTrailers()

getTrailers() : array

获取 Trailer 列表

Returns

array

hasTrailer()

hasTrailer(string  $name) : boolean

Trailer 是否存在

Parameters

string $name

Returns

boolean

getTrailer()

getTrailer(string  $name) : string|null

获取 Trailer 值

Parameters

string $name

Returns

string|null

withTrailer()

withTrailer(string  $name, string  $value) : \Imi\Server\Http\Message\Response

获取 Trailer

Parameters

string $name
string $value

Returns

\Imi\Server\Http\Message\Response

write()

write(string  $content) : \Imi\Server\Http\Message\Response

输出内容,但不发送

Parameters

string $content

Returns

\Imi\Server\Http\Message\Response

redirect()

redirect(string  $url, integer  $status = \Imi\Util\Http\Consts\StatusCode::FOUND) : \Imi\Server\Http\Message\Response

设置服务器端重定向 默认状态码为302

Parameters

string $url
integer $status

Returns

\Imi\Server\Http\Message\Response

sendHeaders()

sendHeaders() : \Imi\Server\Http\Message\Response

发送头部信息,没有特别需求,无需手动调用

Returns

\Imi\Server\Http\Message\Response

sendFile()

sendFile(string  $filename, integer  $offset, integer  $length) : \Imi\Server\Http\Message\Response

发送文件,一般用于文件下载

Parameters

string $filename

要发送的文件名称,文件不存在或没有访问权限sendfile会失败

integer $offset

上传文件的偏移量,可以指定从文件的中间部分开始传输数据。此特性可用于支持断点续传。

integer $length

发送数据的尺寸,默认为整个文件的尺寸

Returns

\Imi\Server\Http\Message\Response

getSwooleResponse()

getSwooleResponse() : \Swoole\Http\Response

获取swoole响应对象

Returns

\Swoole\Http\Response

getServerInstance()

getServerInstance() : \Imi\Server\Base

获取对应的服务器

Returns

\Imi\Server\Base

isEnded()

isEnded() : boolean

是否已结束请求

Returns

boolean

setResponseInstance()

setResponseInstance(\Imi\Server\Http\Message\Response  $response) : void

设置当前上下文中的对象实例

Parameters

\Imi\Server\Http\Message\Response $response