Zend_Json_Server_Error Class Reference

Public Member Functions
	__construct ($message=null, $code=-32000, $data=null)
	setCode ($code)
	getCode ()
	setMessage ($message)
	getMessage ()
	setData ($data)
	getData ()
	toArray ()
	toJson ()
	__toString ()

Data Fields
const	ERROR_PARSE = -32768
const	ERROR_INVALID_REQUEST = -32600
const	ERROR_INVALID_METHOD = -32601
const	ERROR_INVALID_PARAMS = -32602
const	ERROR_INTERNAL = -32603
const	ERROR_OTHER = -32000

Protected Attributes
	$_allowedCodes
	$_code = -32000
	$_data
	$_message

Detailed Description

Definition at line 28 of file Error.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$message = null,
			$code = -32000,
			$data = null
	)

Constructor

Parameters

string	$message
int	$code
mixed	$data

Returns

void

Definition at line 76 of file Error.php.

    {
        $this->setMessage($message)
             ->setCode($code)
             ->setData($data);
    }

Member Function Documentation

__toString()

__toString

(

)

Cast to string (JSON)

Returns

string

Definition at line 193 of file Error.php.

    {
        return $this->toJson();
    }

getCode()

getCode

(

)

Get error code

Returns

int|null

Definition at line 110 of file Error.php.

    {
        return $this->_code;
    }

getData()

getData

(

)

Get error data

Returns

mixed

Definition at line 158 of file Error.php.

    {
        return $this->_data;
    }

getMessage()

getMessage

(

)

Get error message

Returns

string

Definition at line 136 of file Error.php.

    {
        return $this->_message;
    }

setCode()

setCode

(

$code

)

Set error code

Parameters

int

$code

Returns

Zend_Json_Server_Error

Definition at line 89 of file Error.php.

    {
        if (!is_scalar($code)) {
            return $this;
        }

        $code = (int) $code;
        if (in_array($code, $this->_allowedCodes)) {
            $this->_code = $code;
        } elseif (in_array($code, range(-32099, -32000))) {
            $this->_code = $code;
        }

        return $this;
    }

setData()

setData

(

$data

)

Set error data

Parameters

mixed

$data

Returns

Zend_Json_Server_Error

Definition at line 147 of file Error.php.

    {
        $this->_data = $data;
        return $this;
    }

setMessage()

setMessage

(

$message

)

Set error message

Parameters

string

$message

Returns

Zend_Json_Server_Error

Definition at line 121 of file Error.php.

    {
        if (!is_scalar($message)) {
            return $this;
        }

        $this->_message = (string) $message;
        return $this;
    }

toArray()

toArray

(

)

Cast error to array

Returns

array

Definition at line 168 of file Error.php.

    {
        return array(
            'code'    => $this->getCode(),
            'message' => $this->getMessage(),
            'data'    => $this->getData(),
        );
    }

toJson()

toJson

(

)

Cast error to JSON

Returns

string

Definition at line 182 of file Error.php.

    {
        #require_once 'Zend/Json.php';
        return Zend_Json::encode($this->toArray());
    }

Field Documentation

$_allowedCodes

$_allowedCodes

protected

Initial value:

= array(
        self::ERROR_PARSE,
        self::ERROR_INVALID_REQUEST,
        self::ERROR_INVALID_METHOD,
        self::ERROR_INVALID_PARAMS,
        self::ERROR_INTERNAL,
        self::ERROR_OTHER,
    )

Definition at line 41 of file Error.php.

$_code

$_code = -32000

protected

Definition at line 54 of file Error.php.

$_data

$_data

protected

Definition at line 60 of file Error.php.

$_message

$_message

protected

Definition at line 66 of file Error.php.

ERROR_INTERNAL

const ERROR_INTERNAL = -32603

Definition at line 34 of file Error.php.

ERROR_INVALID_METHOD

const ERROR_INVALID_METHOD = -32601

Definition at line 32 of file Error.php.

ERROR_INVALID_PARAMS

const ERROR_INVALID_PARAMS = -32602

Definition at line 33 of file Error.php.

ERROR_INVALID_REQUEST

const ERROR_INVALID_REQUEST = -32600

Definition at line 31 of file Error.php.

ERROR_OTHER

const ERROR_OTHER = -32000

Definition at line 35 of file Error.php.

ERROR_PARSE

const ERROR_PARSE = -32768

Definition at line 30 of file Error.php.

---

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

• vendor/magento/zendframework1/library/Zend/Json/Server/Error.php