Commercetools\Import\Models\Errors\ErrorResponseModel Class Reference

Inheritance diagram for Commercetools\Import\Models\Errors\ErrorResponseModel:

Public Member Functions
	__construct (?int $statusCode=null, ?string $message=null, ?string $error=null, ?string $error_description=null, ?ErrorObjectCollection $errors=null)
	getStatusCode ()
	getMessage ()
	getError ()
	getError_description ()
	getErrors ()
	setStatusCode (?int $statusCode)
	setMessage (?string $message)
	setError (?string $error)
	setError_description (?string $error_description)
	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
	$error
	$error_description
	$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\Import\Models\Errors\ErrorResponse
const	FIELD_STATUS_CODE = 'statusCode'
const	FIELD_MESSAGE = 'message'
const	FIELD_ERROR = 'error'
const	FIELD_ERROR_DESCRIPTION = 'error_description'
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 20 of file ErrorResponseModel.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Import\Models\Errors\ErrorResponseModel::__construct	(	?int	$statusCode = null,
		?string	$message = null,
		?string	$error = null,
		?string	$error_description = null,
		?ErrorObjectCollection	$errors = null
	)

@psalm-suppress MissingParamType

Definition at line 56 of file ErrorResponseModel.php.

Member Function Documentation

getError()

Commercetools\Import\Models\Errors\ErrorResponseModel::getError

(

)

This property is only used for OAuth2 errors. Contains the error code.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 117 of file ErrorResponseModel.php.

getError_description()

Commercetools\Import\Models\Errors\ErrorResponseModel::getError_description

(

)

This property is only used for OAuth2 errors. Additional information to assist the client developer in understanding the error.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 139 of file ErrorResponseModel.php.

getErrors()

Commercetools\Import\Models\Errors\ErrorResponseModel::getErrors

(

)

The errors that caused this error response.

Returns

null|ErrorObjectCollection

@psalm-var ?list<stdClass> $data

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 159 of file ErrorResponseModel.php.

getMessage()

Commercetools\Import\Models\Errors\ErrorResponseModel::getMessage

(

)

Describes the error.

Returns

null|string

@psalm-var ?string $data

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 96 of file ErrorResponseModel.php.

getStatusCode()

Commercetools\Import\Models\Errors\ErrorResponseModel::getStatusCode

(

)

The HTTP status code of the response.

Returns

null|int

@psalm-var ?int $data

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 76 of file ErrorResponseModel.php.

setError()

Commercetools\Import\Models\Errors\ErrorResponseModel::setError

(

?string

$error

)

Parameters

?string

$error

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 193 of file ErrorResponseModel.php.

setError_description()

Commercetools\Import\Models\Errors\ErrorResponseModel::setError_description

(

?string

$error_description

)

Parameters

?string

$error_description

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 201 of file ErrorResponseModel.php.

setErrors()

Commercetools\Import\Models\Errors\ErrorResponseModel::setErrors

(

?ErrorObjectCollection

$errors

)

Parameters

?ErrorObjectCollection

$errors

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 209 of file ErrorResponseModel.php.

setMessage()

Commercetools\Import\Models\Errors\ErrorResponseModel::setMessage

(

?string

$message

)

Parameters

?string

$message

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 185 of file ErrorResponseModel.php.

setStatusCode()

Commercetools\Import\Models\Errors\ErrorResponseModel::setStatusCode

(

?int

$statusCode

)

Parameters

?int	$statusCode

Implements Commercetools\Import\Models\Errors\ErrorResponse.

Definition at line 177 of file ErrorResponseModel.php.

Member Data Documentation

$error

Commercetools\Import\Models\Errors\ErrorResponseModel::$error

protected

Definition at line 38 of file ErrorResponseModel.php.

$error_description

Commercetools\Import\Models\Errors\ErrorResponseModel::$error_description

protected

Definition at line 44 of file ErrorResponseModel.php.

$errors

Commercetools\Import\Models\Errors\ErrorResponseModel::$errors

protected

Definition at line 50 of file ErrorResponseModel.php.

$message

Commercetools\Import\Models\Errors\ErrorResponseModel::$message

protected

Definition at line 32 of file ErrorResponseModel.php.

$statusCode

Commercetools\Import\Models\Errors\ErrorResponseModel::$statusCode

protected

Definition at line 26 of file ErrorResponseModel.php.

---

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

• lib/commercetools-import/src/Models/Errors/ErrorResponseModel.php