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

Public Member Functions

 addFunction ($function, $namespace= '')
 Attach a function or callback to the server.
 
 setClass ($class, $namespace= '', $argv=null)
 Register a class with the server.
 
 fault ($fault=null, $code=404, $data=null)
 Indicate fault response.
 
 handle ($request=false)
 Handle request.
 
 loadFunctions ($definition)
 Load function definitions.
 
 setPersistence ($mode)
 Set server persistence.
 
 setRequest (Zend_Json_Server_Request $request)
 Set request object.
 
 getRequest ()
 Get JSON-RPC request object.
 
 setResponse (Zend_Json_Server_Response $response)
 Set response object.
 
 getResponse ()
 Get response object.
 
 setAutoEmitResponse ($flag)
 Set flag indicating whether or not to auto-emit response.
 
 autoEmitResponse ()
 Will we auto-emit the response?
 
 __call ($method, $args)
 Overload to accessors of SMD object.
 
 getServiceMap ()
 Retrieve SMD object.
 
- Public Member Functions inherited from Zend_Server_Abstract
 __construct ()
 Constructor.
 
 getFunctions ()
 Returns a list of registered methods.
 
- Public Member Functions inherited from Zend_Server_Interface
 fault ($fault=null, $code=404)
 Generate a server fault.
 

Public Attributes

const VERSION_1 = '1.0'
 #@+ Version Constants
 
const VERSION_2 = '2.0'
 

Protected Member Functions

 _addMethodServiceMap (Zend_Server_Method_Definition $method)
 Add service method to service map.
 
 _fixType ($type)
 Translate PHP type to JSON type.
 
 _getDefaultParams (array $args, array $params)
 Get default params from signature.
 
 _getParams (Zend_Server_Method_Definition $method)
 Get method param type.
 
 _getReadyResponse ()
 Set response state.
 
 _getReturnType (Zend_Server_Method_Definition $method)
 Get method return type.
 
 _getSmdMethods ()
 Retrieve list of allowed SMD methods for proxying.
 
 _handle ()
 Internal method for handling request.
 
- Protected Member Functions inherited from Zend_Server_Abstract
 _buildCallback (Zend_Server_Reflection_Function_Abstract $reflection)
 Build callback for method signature.
 
 _buildSignature (Zend_Server_Reflection_Function_Abstract $reflection, $class=null)
 Build a method signature.
 
 _dispatch (Zend_Server_Method_Definition $invocable, array $params)
 Dispatch method.
 
 _fixType ($type)
 Map PHP type to protocol type.
 

Protected Attributes

 $_autoEmitResponse = true
 
 $_overwriteExistingMethods = true
 
 $_request
 
 $_response
 
 $_serviceMap
 
 $_smdMethods
 
 $_table
 
- Protected Attributes inherited from Zend_Server_Abstract
 $_overwriteExistingMethods = false
 
 $_table
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Server_Abstract
static lowerCase (&$value, &$key)
 Lowercase a string.
 
- Static Protected Attributes inherited from Zend_Server_Abstract
static $magic_methods
 

Member Function Documentation

__call (   $method,
  $args 
)

Overload to accessors of SMD object.

Parameters
string$method
array$args
Returns
mixed
_addMethodServiceMap ( Zend_Server_Method_Definition  $method)
protected

Add service method to service map.

Parameters
Zend_Server_Reflection_Function$method
Returns
void
_fixType (   $type)
protected

Translate PHP type to JSON type.

Parameters
string$type
Returns
string
_getDefaultParams ( array  $args,
array  $params 
)
protected

Get default params from signature.

Parameters
array$args
array$params
Returns
array
_getParams ( Zend_Server_Method_Definition  $method)
protected

Get method param type.

Parameters
Zend_Server_Reflection_Function_Abstract$method
Returns
string|array
_getReadyResponse ( )
protected

Set response state.

Returns
Zend_Json_Server_Response
_getReturnType ( Zend_Server_Method_Definition  $method)
protected

Get method return type.

Parameters
Zend_Server_Reflection_Function_Abstract$method
Returns
string|array
_getSmdMethods ( )
protected

Retrieve list of allowed SMD methods for proxying.

Returns
array
_handle ( )
protected

Internal method for handling request.

Returns
void
addFunction (   $function,
  $namespace = '' 
)

Attach a function or callback to the server.

Parameters
string | array$functionValid PHP callback
string$namespaceIgnored
Returns
Zend_Json_Server

Implements Zend_Server_Interface.

autoEmitResponse ( )

Will we auto-emit the response?

Returns
bool
fault (   $fault = null,
  $code = 404,
  $data = null 
)

Indicate fault response.

Parameters
string$fault
int$code
Returns
false
getRequest ( )

Get JSON-RPC request object.

Returns
Zend_Json_Server_Request
getResponse ( )

Get response object.

Returns
Zend_Json_Server_Response
getServiceMap ( )

Retrieve SMD object.

Returns
Zend_Json_Server_Smd
handle (   $request = false)

Handle request.

Parameters
Zend_Json_Server_Request$request
Returns
null|Zend_Json_Server_Response

Implements Zend_Server_Interface.

loadFunctions (   $definition)

Load function definitions.

Parameters
array | Zend_Server_Definition$definition
Returns
void

Implements Zend_Server_Interface.

setAutoEmitResponse (   $flag)

Set flag indicating whether or not to auto-emit response.

Parameters
bool$flag
Returns
Zend_Json_Server
setClass (   $class,
  $namespace = '',
  $argv = null 
)

Register a class with the server.

Parameters
string$class
string$namespaceIgnored
mixed$argvIgnored
Returns
Zend_Json_Server

Implements Zend_Server_Interface.

setPersistence (   $mode)

Set server persistence.

Todo:
Determine how to implement this
Parameters
int$mode
Returns
void

Implements Zend_Server_Interface.

setRequest ( Zend_Json_Server_Request  $request)

Set request object.

Parameters
Zend_Json_Server_Request$request
Returns
Zend_Json_Server
setResponse ( Zend_Json_Server_Response  $response)

Set response object.

Parameters
Zend_Json_Server_Response$response
Returns
Zend_Json_Server

Member Data Documentation

$_autoEmitResponse = true
protected
$_overwriteExistingMethods = true
protected
$_request
protected
$_response
protected
$_serviceMap
protected
$_smdMethods
protected
$_table
protected
const VERSION_1 = '1.0'

#@+ Version Constants

const VERSION_2 = '2.0'