Commercetools\Api\Models\Error\ErrorResponseModel Class Reference

Inheritance diagram for Commercetools\Api\Models\Error\ErrorResponseModel:

Public Member Functions
	__construct (?int $statusCode=null, ?string $message=null, ?ErrorObjectCollection $errors=null)
	getStatusCode ()
	getMessage ()
	getErrors ()
	setStatusCode (?int $statusCode)
	setMessage (?string $message)
	setErrors (?ErrorObjectCollection $errors)
Public Member Functions inherited from Commercetools\Base\JsonObjectModel
	get (string $field)
	with (callable $callable=null)
Public Member Functions inherited from Commercetools\Base\BaseJsonObject
	jsonSerialize ()

Protected Attributes
	$statusCode
	$message
	$errors

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\BaseJsonObject
static	of ($data=null)
static	fromStdClass (stdClass $data=null)
static	fromArray (array $data=[])
Public Attributes inherited from Commercetools\Api\Models\Error\ErrorResponse
const	FIELD_STATUS_CODE = 'statusCode'
const	FIELD_MESSAGE = 'message'
const	FIELD_ERRORS = 'errors'
Protected Member Functions inherited from Commercetools\Base\JsonObjectModel
	toArray ()
Protected Member Functions inherited from Commercetools\Base\BaseJsonObject
	raw (string $field)
	getRawDataArray ()

Detailed Description

Definition at line 22 of file ErrorResponseModel.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Models\Error\ErrorResponseModel::__construct	(	?int	$statusCode = null,
		?string	$message = null,
		?ErrorObjectCollection	$errors = null
	)

@psalm-suppress MissingParamType

Definition at line 46 of file ErrorResponseModel.php.

Member Function Documentation

getErrors()

Commercetools\Api\Models\Error\ErrorResponseModel::getErrors

(

)

Errors returned for a request.

A single error response can contain multiple errors if the errors are related to the same HTTP status code such as 400.

Returns

null|ErrorObjectCollection

@psalm-var ?list<stdClass> $data

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 103 of file ErrorResponseModel.php.

getMessage()

Commercetools\Api\Models\Error\ErrorResponseModel::getMessage

(

)

First error message in the errors array.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 82 of file ErrorResponseModel.php.

getStatusCode()

Commercetools\Api\Models\Error\ErrorResponseModel::getStatusCode

(

)

HTTP status code corresponding to the error.

Returns

null|int

@psalm-var ?int $data

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 62 of file ErrorResponseModel.php.

setErrors()

Commercetools\Api\Models\Error\ErrorResponseModel::setErrors

(

?ErrorObjectCollection

$errors

)

Parameters

?ErrorObjectCollection

$errors

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 137 of file ErrorResponseModel.php.

setMessage()

Commercetools\Api\Models\Error\ErrorResponseModel::setMessage

(

?string

$message

)

Parameters

?string

$message

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 129 of file ErrorResponseModel.php.

setStatusCode()

Commercetools\Api\Models\Error\ErrorResponseModel::setStatusCode

(

?int

$statusCode

)

Parameters

?int	$statusCode

Implements Commercetools\Api\Models\Error\ErrorResponse.

Definition at line 121 of file ErrorResponseModel.php.

Member Data Documentation

$errors

Commercetools\Api\Models\Error\ErrorResponseModel::$errors

protected

Definition at line 40 of file ErrorResponseModel.php.

$message

Commercetools\Api\Models\Error\ErrorResponseModel::$message

protected

Definition at line 34 of file ErrorResponseModel.php.

$statusCode

Commercetools\Api\Models\Error\ErrorResponseModel::$statusCode

protected

Definition at line 28 of file ErrorResponseModel.php.

---

The documentation for this class was generated from the following file:

• lib/commercetools-api/src/Models/Error/ErrorResponseModel.php