category Zend
package Zend_Json
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Json_Server_Request

 Methods

Constructor

__construct() : void

Pull JSON request from raw POST body and use to populate request.

Cast request to string (JSON)

__toString() : string
Inherited

Returns

string

Add a parameter to the request

addParam(mixed $value, string $key = null) : \Zend_Json_Server_Request
Inherited

Parameters

$value

mixed

$key

string

Returns

\Zend_Json_Server_Request

Add many params

addParams(array $params) : \Zend_Json_Server_Request
Inherited

Parameters

$params

array

Returns

\Zend_Json_Server_Request

Retrieve request identifier

getId() : mixed
Inherited

Returns

mixed

Get request method name

getMethod() : string
Inherited

Returns

string

Retrieve param by index or key

getParam(integer|string $index) : mixed | null
Inherited

Parameters

$index

integerstring

Returns

mixednullNull when not found

Retrieve parameters

getParams() : array
Inherited

Returns

array

Get JSON from raw POST body

getRawJson() : string

Returns

string

Retrieve JSON-RPC version

getVersion() : string
Inherited

Returns

string

Was a bad method provided?

isMethodError() : boolean
Inherited

Returns

boolean

Set request state based on JSON

loadJson(string $json) : void
Inherited

Parameters

$json

string

Set request identifier

setId(mixed $name) : \Zend_Json_Server_Request
Inherited

Parameters

$name

mixed

Returns

\Zend_Json_Server_Request

Set request method

setMethod(string $name) : \Zend_Json_Server_Request
Inherited

Parameters

$name

string

Returns

\Zend_Json_Server_Request

Set request state

setOptions(array $options) : \Zend_Json_Server_Request
Inherited

Parameters

$options

array

Returns

\Zend_Json_Server_Request

Overwrite params

setParams(array $params) : \Zend_Json_Server_Request
Inherited

Parameters

$params

array

Returns

\Zend_Json_Server_Request

Set JSON-RPC version

setVersion(string $version) : \Zend_Json_Server_Request
Inherited

Parameters

$version

string

Returns

\Zend_Json_Server_Request

Cast request to JSON

toJson() : string
Inherited

Returns

string

 Properties

 

Request ID

$_id : mixed

Default

 

Flag

$_isMethodError : boolean

Default

false
 

Requested method

$_method : string

Default

 

Regex for method

$_methodRegex : string

Default

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

Request parameters

$_params : array

Default

array()
 

Raw JSON pulled from POST body

$_rawJson : string

Default

 

JSON-RPC version of request

$_version : string

Default

'1.0'