Zend_Json_Server_Response Class Reference

Inheritance diagram for Zend_Json_Server_Response:

Public Member Functions
	setResult ($value)
	getResult ()
	setError (Zend_Json_Server_Error $error)
	getError ()
	isError ()
	setId ($name)
	getId ()
	setVersion ($version)
	getVersion ()
	toJson ()
	getArgs ()
	setArgs ($args)
	setServiceMap ($serviceMap)
	getServiceMap ()
	__toString ()

Protected Attributes
	$_error
	$_id
	$_result
	$_serviceMap
	$_version

Detailed Description

Definition at line 30 of file Response.php.

Member Function Documentation

__toString()

__toString

(

)

Cast to string (JSON)

Returns

string

Definition at line 244 of file Response.php.

    {
        return $this->toJson();
    }

getArgs()

getArgs

(

)

Retrieve args

Returns

mixed

Definition at line 200 of file Response.php.

    {
        return $this->_args;
    }

getError()

getError

(

)

Get response error

Returns

null|Zend_Json_Server_Error

Definition at line 102 of file Response.php.

    {
        return $this->_error;
    }

getId()

getId

(

)

Get request ID

Returns

mixed

Definition at line 134 of file Response.php.

    {
        return $this->_id;
    }

getResult()

getResult

(

)

Get result

Returns

mixed

Definition at line 79 of file Response.php.

    {
        return $this->_result;
    }

getServiceMap()

getServiceMap

(

)

Retrieve service map

Returns

Zend_Json_Server_Smd|null

Definition at line 234 of file Response.php.

    {
        return $this->_serviceMap;
    }

getVersion()

getVersion

(

)

Retrieve JSON-RPC version

Returns

string

Definition at line 163 of file Response.php.

    {
        return $this->_version;
    }

isError()

isError

(

)

Is the response an error?

Returns

bool

Definition at line 112 of file Response.php.

    {
        return $this->getError() instanceof Zend_Json_Server_Error;
    }

setArgs()

setArgs

(

$args

)

Set args

Parameters

mixed

$args

Returns

self

Definition at line 211 of file Response.php.

    {
        $this->_args = $args;
        return $this;
    }

setError()

setError

(

Zend_Json_Server_Error

$error

)

Set result error

Parameters

Zend_Json_Server_Error

$error

Returns

Zend_Json_Server_Response

Definition at line 91 of file Response.php.

    {
        $this->_error = $error;
        return $this;
    }

setId()

setId

(

$name

)

Set request ID

Parameters

mixed

$name

Returns

Zend_Json_Server_Response

Definition at line 123 of file Response.php.

    {
        $this->_id = $name;
        return $this;
    }

setResult()

setResult

(

$value

)

Set result

Parameters

mixed

$value

Returns

Zend_Json_Server_Response

Definition at line 68 of file Response.php.

    {
        $this->_result = $value;
        return $this;
    }

setServiceMap()

setServiceMap

(

$serviceMap

)

Set service map object

Parameters

Zend_Json_Server_Smd

$serviceMap

Returns

Zend_Json_Server_Response

Definition at line 223 of file Response.php.

    {
        $this->_serviceMap = $serviceMap;
        return $this;
    }

setVersion()

setVersion

(

$version

)

Set JSON-RPC version

Parameters

string

$version

Returns

Zend_Json_Server_Response

Definition at line 145 of file Response.php.

    {
        $version = is_array($version)
            ? implode(' ', $version)
            : $version;
        if ((string)$version == '2.0') {
            $this->_version = '2.0';
        } else {
            $this->_version = null;
        }
        return $this;
    }

toJson()

toJson

(

)

Cast to JSON

Returns

string

Definition at line 173 of file Response.php.

    {
        if ($this->isError()) {
            $response = array(
                'error'  => $this->getError()->toArray(),
                'id'     => $this->getId(),
            );
        } else {
            $response = array(
                'result' => $this->getResult(),
                'id'     => $this->getId(),
            );
        }

        if (null !== ($version = $this->getVersion())) {
            $response['jsonrpc'] = $version;
        }

        #require_once 'Zend/Json.php';
        return Zend_Json::encode($response);
    }

Field Documentation

$_error

$_error

protected

Definition at line 36 of file Response.php.

$_id

$_id

protected

Definition at line 42 of file Response.php.

$_result

$_result

protected

Definition at line 48 of file Response.php.

$_serviceMap

$_serviceMap

protected

Definition at line 54 of file Response.php.

$_version

$_version

protected

Definition at line 60 of file Response.php.

---

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

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