Public Member Functions | Protected Attributes

Zend_Json_Server_Request Class Reference

Inheritance diagram for Zend_Json_Server_Request:
Zend_Json_Server_Request_Http

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 (  )

Cast request to string (JSON)

Returns:
string

Definition at line 285 of file Request.php.

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.

addParams ( array $  params )

Add many params

Parameters:
array$params
Returns:
Zend_Json_Server_Request

Definition at line 113 of file Request.php.

getId (  )

Retrieve request identifier

Returns:
mixed

Definition at line 211 of file Request.php.

getMethod (  )

Get request method name

Returns:
string

Definition at line 179 of file Request.php.

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.

getParams (  )

Retrieve parameters

Returns:
array

Definition at line 153 of file Request.php.

getVersion (  )

Retrieve JSON-RPC version

Returns:
string

Definition at line 237 of file Request.php.

isMethodError (  )

Was a bad method provided?

Returns:
bool

Definition at line 189 of file Request.php.

loadJson ( json )

Set request state based on JSON

Parameters:
string$json
Returns:
void

Definition at line 248 of file Request.php.

setId ( name )

Set request identifier

Parameters:
mixed$name
Returns:
Zend_Json_Server_Request

Definition at line 200 of file Request.php.

setMethod ( name )

Set request method

Parameters:
string$name
Returns:
Zend_Json_Server_Request

Definition at line 164 of file Request.php.

setOptions ( array $  options )

Set request state

Parameters:
array$options
Returns:
Zend_Json_Server_Request

Definition at line 74 of file Request.php.

setParams ( array $  params )

Overwrite params

Parameters:
array$params
Returns:
Zend_Json_Server_Request

Definition at line 127 of file Request.php.

setVersion ( version )

Set JSON-RPC version

Parameters:
string$version
Returns:
Zend_Json_Server_Request

Definition at line 222 of file Request.php.

toJson (  )

Cast request to JSON

Returns:
string

Definition at line 260 of file Request.php.


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