Zend_Json_Server_Request Class Reference

Inheritance diagram for Zend_Json_Server_Request:

Public Member Functions
	setOptions (array $options)
	addParam ($value, $key=null)
	addParams (array $params)
	setParams (array $params)
	getParam ($index)
	getParams ()
	setMethod ($name)
	getMethod ()
	isMethodError ()
	setId ($name)
	getId ()
	setVersion ($version)
	getVersion ()
	loadJson ($json)
	toJson ()
	__toString ()

Protected Attributes
	$_id
	$_isMethodError = false
	$_method
	$_methodRegex = '/^[a-z][a-z0-9_.]*$/i'
	$_params = array()
	$_version = '1.0'

Detailed Description

Definition at line 30 of file Request.php.

Member Function Documentation

__toString()

__toString

(

)

Cast request to string (JSON)

Returns

string

Definition at line 285 of file Request.php.

    {
        return $this->toJson();
    }

addParam()

addParam	(		$value,
			$key = null
	)

Add a parameter to the request

Parameters

mixed	$value
string	$key

Returns

Zend_Json_Server_Request

Definition at line 95 of file Request.php.

    {
        if ((null === $key) || !is_string($key)) {
            $index = count($this->_params);
            $this->_params[$index] = $value;
        } else {
            $this->_params[$key] = $value;
        }

        return $this;
    }

addParams()

addParams

(

array

$params

)

Add many params

Parameters

array

$params

Returns

Zend_Json_Server_Request

Definition at line 113 of file Request.php.

    {
        foreach ($params as $key => $value) {
            $this->addParam($value, $key);
        }
        return $this;
    }

getId()

getId

(

)

Retrieve request identifier

Returns

mixed

Definition at line 211 of file Request.php.

    {
        return $this->_id;
    }

getMethod()

getMethod

(

)

Get request method name

Returns

string

Definition at line 179 of file Request.php.

    {
        return $this->_method;
    }

getParam()

getParam

(

$index

)

Retrieve param by index or key

Parameters

int | string

$index

Returns

mixed|null Null when not found

Definition at line 139 of file Request.php.

    {
        if (array_key_exists($index, $this->_params)) {
            return $this->_params[$index];
        }

        return null;
    }

getParams()

getParams

(

)

Retrieve parameters

Returns

array

Definition at line 153 of file Request.php.

    {
        return $this->_params;
    }

getVersion()

getVersion

(

)

Retrieve JSON-RPC version

Returns

string

Definition at line 237 of file Request.php.

    {
        return $this->_version;
    }

isMethodError()

isMethodError

(

)

Was a bad method provided?

Returns

bool

Definition at line 189 of file Request.php.

    {
        return $this->_isMethodError;
    }

loadJson()

loadJson

(

$json

)

Set request state based on JSON

Parameters

string

$json

Returns

void

Definition at line 248 of file Request.php.

    {
        #require_once 'Zend/Json.php';
        $options = Zend_Json::decode($json);
        $this->setOptions($options);
    }

setId()

setId

(

$name

)

Set request identifier

Parameters

mixed

$name

Returns

Zend_Json_Server_Request

Definition at line 200 of file Request.php.

    {
        $this->_id = (string) $name;
        return $this;
    }

setMethod()

setMethod

(

$name

)

Set request method

Parameters

string

$name

Returns

Zend_Json_Server_Request

Definition at line 164 of file Request.php.

    {
        if (!preg_match($this->_methodRegex, $name)) {
            $this->_isMethodError = true;
        } else {
            $this->_method = $name;
        }
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set request state

Parameters

array

$options

Returns

Zend_Json_Server_Request

Definition at line 74 of file Request.php.

    {
        $methods = get_class_methods($this);
        foreach ($options as $key => $value) {
            $method = 'set' . ucfirst($key);
            if (in_array($method, $methods)) {
                $this->$method($value);
            } elseif ($key == 'jsonrpc') {
                $this->setVersion($value);
            }
        }
        return $this;
    }

setParams()

setParams

(

array

$params

)

Overwrite params

Parameters

array

$params

Returns

Zend_Json_Server_Request

Definition at line 127 of file Request.php.

    {
        $this->_params = array();
        return $this->addParams($params);
    }

setVersion()

setVersion

(

$version

)

Set JSON-RPC version

Parameters

string

$version

Returns

Zend_Json_Server_Request

Definition at line 222 of file Request.php.

    {
        if ('2.0' == $version) {
            $this->_version = '2.0';
        } else {
            $this->_version = '1.0';
        }
        return $this;
    }

toJson()

toJson

(

)

Cast request to JSON

Returns

string

Definition at line 260 of file Request.php.

    {
        $jsonArray = array(
            'method' => $this->getMethod()
        );
        if (null !== ($id = $this->getId())) {
            $jsonArray['id'] = $id;
        }
        $params = $this->getParams();
        if (!empty($params)) {
            $jsonArray['params'] = $params;
        }
        if ('2.0' == $this->getVersion()) {
            $jsonArray['jsonrpc'] = '2.0';
        }

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

Field Documentation

$_id

$_id

protected

Definition at line 36 of file Request.php.

$_isMethodError

$_isMethodError = false

protected

Definition at line 42 of file Request.php.

$_method

$_method

protected

Definition at line 48 of file Request.php.

$_methodRegex

$_methodRegex = '/^[a-z][a-z0-9_.]*$/i'

protected

Definition at line 54 of file Request.php.

$_params

$_params = array()

protected

Definition at line 60 of file Request.php.

$_version

$_version = '1.0'

protected

Definition at line 66 of file Request.php.

---

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

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