CheddarGetter Client
\

\CheddarGetter_Response_Exception

Response exception object

Summary

Methods
Properties
Constants
__construct()
setId()
setAuxCode()
getId()
getAuxCode()
No public properties found
REQUEST_INVALID
NOT_FOUND
PRECONDITION_FAILED
UNPROCESSABLE_ENTITY
DATA_INVALID
USAGE_INVALID
UNKNOWN
No protected methods found
$id
$auxCode
N/A
No private methods found
No private properties found
N/A

Constants

REQUEST_INVALID

REQUEST_INVALID

NOT_FOUND

NOT_FOUND

PRECONDITION_FAILED

PRECONDITION_FAILED

UNPROCESSABLE_ENTITY

UNPROCESSABLE_ENTITY

DATA_INVALID

DATA_INVALID

USAGE_INVALID

USAGE_INVALID

UNKNOWN

UNKNOWN

Properties

$id

$id : int|null

The log id of the error

Type

int|null

$auxCode

$auxCode : string|null

The auxCode of the error

The auxCode is set if the error response contains one. It references additional information about the error. For more information, see the error handling KB article

Type

string|null

Methods

__construct()

__construct(string|null $message, int $code, string|null $id, string|null $auxCode)

Constructor

Parameters

string|null $message

The message from the error response
int $code

The error code from the response (http status code)
string|null $id

The log id of the error record
string|null $auxCode

The auxCode from the error response

getId()

getId() : int|null

Get the error log id

Returns

int|null

getAuxCode()

getAuxCode() : string|null

Get the error auxCode

Returns

string|null