Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Json_Server_Request Class Reference

Public Member Functions

 setOptions (array $options)
 Set request state.
 
 addParam ($value, $key=null)
 Add a parameter to the request.
 
 addParams (array $params)
 Add many params.
 
 setParams (array $params)
 Overwrite params.
 
 getParam ($index)
 Retrieve param by index or key.
 
 getParams ()
 Retrieve parameters.
 
 setMethod ($name)
 Set request method.
 
 getMethod ()
 Get request method name.
 
 isMethodError ()
 Was a bad method provided?
 
 setId ($name)
 Set request identifier.
 
 getId ()
 Retrieve request identifier.
 
 setVersion ($version)
 Set JSON-RPC version.
 
 getVersion ()
 Retrieve JSON-RPC version.
 
 loadJson ($json)
 Set request state based on JSON.
 
 toJson ()
 Cast request to JSON.
 
 __toString ()
 Cast request to string (JSON)
 

Protected Attributes

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

Member Function Documentation

__toString ( )

Cast request to string (JSON)

Returns
string
addParam (   $value,
  $key = null 
)

Add a parameter to the request.

Parameters
mixed$value
string$key
Returns
Zend_Json_Server_Request
addParams ( array  $params)

Add many params.

Parameters
array$params
Returns
Zend_Json_Server_Request
getId ( )

Retrieve request identifier.

Returns
mixed
getMethod ( )

Get request method name.

Returns
string
getParam (   $index)

Retrieve param by index or key.

Parameters
int | string$index
Returns
mixed|null Null when not found
getParams ( )

Retrieve parameters.

Returns
array
getVersion ( )

Retrieve JSON-RPC version.

Returns
string
isMethodError ( )

Was a bad method provided?

Returns
bool
loadJson (   $json)

Set request state based on JSON.

Parameters
string$json
Returns
void
setId (   $name)

Set request identifier.

Parameters
mixed$name
Returns
Zend_Json_Server_Request
setMethod (   $name)

Set request method.

Parameters
string$name
Returns
Zend_Json_Server_Request
setOptions ( array  $options)

Set request state.

Parameters
array$options
Returns
Zend_Json_Server_Request
setParams ( array  $params)

Overwrite params.

Parameters
array$params
Returns
Zend_Json_Server_Request
setVersion (   $version)

Set JSON-RPC version.

Parameters
string$version
Returns
Zend_Json_Server_Request
toJson ( )

Cast request to JSON.

Returns
string

Member Data Documentation

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