category |
Zend |
package |
Zend_Json |
subpackage |
Server |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
Methods
Cast request to string (JSON)
__toString() : string
Add a parameter to the request
addParam(mixed $value, string $key = null
) : \Zend_Json_Server_Request
Parameters
$value
mixed
$key
string
Returns
\Zend_Json_Server_Request
Add many params
addParams(array $params) : \Zend_Json_Server_Request
Parameters
$params
array
Returns
\Zend_Json_Server_Request
Retrieve request identifier
getId() : mixed
Get request method name
getMethod() : string
Retrieve param by index or key
getParam(integer|string $index) : mixed | null
Parameters
$index
integer
string
Returns
mixed
null
Null when not found
Retrieve parameters
getParams() : array
Retrieve JSON-RPC version
getVersion() : string
Was a bad method provided?
isMethodError() : boolean
Set request state based on JSON
loadJson(string $json) : void
Set request identifier
setId(mixed $name) : \Zend_Json_Server_Request
Parameters
$name
mixed
Returns
\Zend_Json_Server_Request
Set request method
setMethod(string $name) : \Zend_Json_Server_Request
Parameters
$name
string
Returns
\Zend_Json_Server_Request
Set request state
setOptions(array $options) : \Zend_Json_Server_Request
Parameters
$options
array
Returns
\Zend_Json_Server_Request
Overwrite params
setParams(array $params) : \Zend_Json_Server_Request
Parameters
$params
array
Returns
\Zend_Json_Server_Request
Set JSON-RPC version
setVersion(string $version) : \Zend_Json_Server_Request
Parameters
$version
string
Returns
\Zend_Json_Server_Request
Cast request to JSON
toJson() : string
Properties
Flag
$_isMethodError : boolean
Requested method
$_method : string
Regex for method
$_methodRegex : string
Default
'/^[a-z][a-z0-9_.]*$/i'
Request parameters
$_params : array
JSON-RPC version of request
$_version : string