\AlibabaCloud\TeaResponse

Class Response.

Summary

Methods

Properties

Constants

__construct()
getStatusCode()
getReasonPhrase()
withStatus()
getProtocolVersion()
withProtocolVersion()
getHeaders()
hasHeader()
getHeader()
getHeaderLine()
withHeader()
withAddedHeader()
withoutHeader()
getBody()
withBody()
__toString()
__get()
__set()
__isset()
__unset()
toArray()
add()
all()
clear()
delete()
flatten()
get()
has()
isEmpty()
merge()
mergeRecursive()
mergeRecursiveDistinct()
pull()
push()
replace()
set()
setArray()
setReference()
toJson()
getIterator()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
count()

$statusCode
$headers
$statusMessage
$info
$body

No constants found

No protected methods found

$dot

N/A

assertStatusCodeIsInteger()
assertStatusCodeRange()
setHeaders()
normalizeHeaderValue()
trimHeaderValues()
assertHeader()

$phrases
$reasonPhrase
$headerNames
$protocol
$stream

N/A

File: serve/vendor/alibabacloud/tea/src/Response.php
Package: Application
Class hierarchy: Response

\AlibabaCloud\Tea\Response
Implements
Uses

Properties

$statusCode

$statusCode : int

Type

int —

$headers

$headers

$statusMessage

$statusMessage

$info

$info : \GuzzleHttp\TransferStats

Type

TransferStats —

$body

$body : \Psr\Http\Message\StreamInterface

Type

StreamInterface —

$dot

$dot : \Adbar\Dot

Instance of the Dot.

Type

Dot —

$phrases

$phrases : array

Type

array — Map of standard HTTP status code/reason phrases

$reasonPhrase

$reasonPhrase : string

Type

string —

$headerNames

$headerNames : array

Type

array — Map of lowercase header name => original name at registration

$protocol

$protocol : string

Type

string —

$stream

$stream : \Psr\Http\Message\StreamInterface|null

Type

StreamInterface|null —

Methods

__construct()

__construct(\Psr\Http\Message\ResponseInterface  $response) : mixed

Response constructor.

Parameters

\Psr\Http\Message\ResponseInterface

$response

Returns

mixed —

getStatusCode()

getStatusCode() : int

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

int —

Status code.

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.

withStatus()

withStatus(mixed  $code, mixed  $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

mixed	$code	The 3-digit integer result code to set.
mixed	$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.

Returns

static —

getProtocolVersion()

getProtocolVersion() : mixed

Returns

mixed —

withProtocolVersion()

withProtocolVersion(mixed  $version) : mixed

Parameters

mixed

$version

Returns

mixed —

getHeaders()

getHeaders() : mixed

Returns

mixed —

hasHeader()

hasHeader(mixed  $header) : mixed

Parameters

mixed

$header

Returns

mixed —

getHeader()

getHeader(mixed  $header) : mixed

Parameters

mixed

$header

Returns

mixed —

getHeaderLine()

getHeaderLine(mixed  $header) : mixed

Parameters

mixed

$header

Returns

mixed —

withHeader()

withHeader(mixed  $header, mixed  $value) : mixed

Parameters

mixed	$header
mixed	$value

Returns

mixed —

withAddedHeader()

withAddedHeader(mixed  $header, mixed  $value) : mixed

Parameters

mixed	$header
mixed	$value

Returns

mixed —

withoutHeader()

withoutHeader(mixed  $header) : mixed

Parameters

mixed

$header

Returns

mixed —

getBody()

getBody() : mixed

Returns

mixed —

withBody()

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

Parameters

\Psr\Http\Message\StreamInterface

$body

Returns

mixed —

__toString()

__toString() : string

Returns

string —

__get()

__get(string  $name) : null|mixed

Parameters

string

$name

Returns

null|mixed —

__set()

__set(string  $name, mixed  $value) : mixed

Parameters

string	$name
mixed	$value

Returns

mixed —

__isset()

__isset(string  $name) : bool

Parameters

string

$name

Returns

bool —

__unset()

__unset( $offset) : mixed

Parameters

$offset

Returns

mixed —

toArray()

toArray() : array

Returns

array —

add()

add(array|int|string  $keys, mixed  $value = null) : mixed

Parameters

array\|int\|string	$keys
mixed	$value

Returns

mixed —

all()

all() : array

Returns

array —

clear()

clear(null|array|int|string  $keys = null) : mixed

Parameters

null|array|int|string

$keys

Returns

mixed —

delete()

delete(array|int|string  $keys) : mixed

Parameters

array|int|string

$keys

Returns

mixed —

flatten()

flatten(string  $delimiter = '.', null|array  $items = null, string  $prepend = '') : array

Parameters

string	$delimiter
null\|array	$items
string	$prepend

Returns

array —

get()

get(null|int|string  $key = null, mixed  $default = null) : mixed

Parameters

null\|int\|string	$key
mixed	$default

Returns

mixed —

has()

has(array|int|string  $keys) : bool

Parameters

array|int|string

$keys

Returns

bool —

isEmpty()

isEmpty(null|array|int|string  $keys = null) : bool

Parameters

null|array|int|string

$keys

Returns

bool —

merge()

merge(array|self|string  $key, array|self  $value = []) : mixed

Parameters

array\|self\|string	$key
array\|self	$value

Returns

mixed —

mergeRecursive()

mergeRecursive(array|self|string  $key, array|self  $value = []) : mixed

Parameters

array\|self\|string	$key
array\|self	$value

Returns

mixed —

mergeRecursiveDistinct()

mergeRecursiveDistinct(array|self|string  $key, array|self  $value = []) : mixed

Parameters

array\|self\|string	$key
array\|self	$value

Returns

mixed —

pull()

pull(null|int|string  $key = null, mixed  $default = null) : mixed

Parameters

null\|int\|string	$key
mixed	$default

Returns

mixed —

push()

push(null|int|string  $key = null, mixed  $value = null) : mixed

Parameters

null\|int\|string	$key
mixed	$value

Returns

mixed —

replace()

replace(array|self|string  $key, array|self  $value = []) : mixed

Replace all values or values within the given key with an array or Dot object.

Parameters

array\|self\|string	$key
array\|self	$value

Returns

mixed —

set()

set(array|int|string  $keys, mixed  $value = null) : mixed

Set a given key / value pair or pairs.

Parameters

array\|int\|string	$keys
mixed	$value

Returns

mixed —

setArray()

setArray(mixed  $items) : mixed

Replace all items with a given array.

Parameters

mixed

$items

Returns

mixed —

setReference()

setReference(array  $items) : mixed

Replace all items with a given array as a reference.

Parameters

array

$items

Returns

mixed —

toJson()

toJson(mixed  $key = null, int  $options) : string

Return the value of a given key or all the values as JSON.

Parameters

mixed	$key
int	$options

Returns

string —

getIterator()

getIterator() : mixed

Retrieve an external iterator.

Returns

mixed —

offsetExists()

offsetExists( $offset) : bool

Whether a offset exists.

Parameters

$offset

Returns

bool —

offsetGet()

offsetGet( $offset) : mixed

Offset to retrieve.

Parameters

$offset

Returns

mixed —

offsetSet()

offsetSet( $offset,  $value) : mixed

Offset to set.

Parameters

	$offset
	$value

Returns

mixed —

offsetUnset()

offsetUnset( $offset) : mixed

Offset to unset.

Parameters

$offset

Returns

mixed —

count()

count(null  $key = null) : int

Count elements of an object.

Parameters

null

$key

Returns

int —

assertStatusCodeIsInteger()

assertStatusCodeIsInteger(mixed  $statusCode) : mixed

Parameters

mixed

$statusCode

Returns

mixed —

assertStatusCodeRange()

assertStatusCodeRange(mixed  $statusCode) : mixed

Parameters

mixed

$statusCode

Returns

mixed —

setHeaders()

setHeaders(array  $headers) : mixed

Parameters

array

$headers

Returns

mixed —

normalizeHeaderValue()

normalizeHeaderValue(mixed  $value) : mixed

Parameters

mixed

$value

Returns

mixed —

trimHeaderValues()

trimHeaderValues(string[]  $values) : string[]

Trims whitespace from the header values.

Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field.

header-field = field-name ":" OWS field-value OWS OWS = *( SP / HTAB )

Parameters

string[]

$values

Header values

Returns

string[] —

Trimmed header values

assertHeader()

assertHeader(mixed  $header) : mixed

Parameters

mixed

$header

Returns

mixed —