\OSS\ResultHeaderResult

Class HeaderResult

Summary

Methods

Properties

Constants

__construct()
getRequestId()
getData()
isOK()
parseResponse()
getRawResponse()

No public properties found

No constants found

parseDataFromResponse()
isResponseOk()

$isOk
$parsedData
$rawResponse

N/A

retrieveErrorMessage()
retrieveErrorCode()

No private properties found

N/A

Properties

$isOk

$isOk :

Indicate whether the request is successful

Type

$parsedData

$parsedData :

Data parsed by subclasses

Type

$rawResponse

$rawResponse : \OSS\Http\ResponseCore

Store the original Response returned by the auth function

Type

\OSS\Http\ResponseCore

Methods

__construct()

__construct(  $response)

Result constructor.

Parameters

$response

ResponseCore

Throws

\OSS\Core\OssException

getRequestId()

getRequestId() : string

Get requestId

Returns

string

getData()

getData()

Get the returned data, different request returns the data format is different

$return mixed

isOK()

isOK() : mixed

Whether the operation is successful

Returns

mixed

parseResponse()

parseResponse()

Throws

\OSS\Core\OssException

getRawResponse()

getRawResponse() : \OSS\Http\ResponseCore

Return the original return data

Returns

\OSS\Http\ResponseCore

parseDataFromResponse()

parseDataFromResponse() : array

The returned ResponseCore header is used as the return data

Returns

array

isResponseOk()

isResponseOk() : boolean

Judging from the return http status code, [200-299] that is OK

Returns

boolean

retrieveErrorMessage()

retrieveErrorMessage(  $body) : string

Try to get the error message from body

Parameters

$body

Returns

string

retrieveErrorCode()

retrieveErrorCode(  $body) : string

Try to get the error Code from body

Parameters

$body

Returns

string