Class dom_xmlrpc_server

Description

Provides basic XML-RPC server functionality

Located in /includes/domit/dom_xmlrpc_server.php (line 48)

php_http_server_generic
   |
   --dom_xmlrpc_server
Variable Summary
Method Summary
dom_xmlrpc_server dom_xmlrpc_server ([object A $customMethods = null], [boolean $postData = null])
void addCustomMethods (object A $customMethods)
void addMappedMethods (object A &$methodmap, array $methodNameList)
void addMethod (array $method)
void addMethods (array $methodsArray)
mixed buildFault (object A $response)
mixed buildMethodResponse (object A $response)
mixed &buildResponse (object A &$response)
array getCapabilities ()
mixed &handleMethodNotFound (string $methodName, mixed &$params)
mixed &invokeMethod (string $xmlText)
boolean isError ()
array listMethods ()
string methodHelp (string $name)
array methodSignature (string $name)
array &multicall (array &$myArray)
void onPost (string $postData)
mixed &parseRequest (string $xmlText)
object An &raiseFault ()
void setHeaders ()
void setHTTPEvents ()
void setMethodNotFoundHandler (object A $method)
void setObjectAwareness (boolean $truthVal)
void setObjectDefinitionHandler (object The $handler)
void tokenizeParams (boolean $truthVal)
Variables
object A $methodmapper (line 50)
  • var: reference to a method mapping class
object A $methodNotFoundHandler = null (line 58)
  • var: reference to the handler for missing methods
array $multiresponse = array() (line 64)
  • var: Repository for multiple method responses
boolean $objectAwareness = false (line 60)
  • var: True if object awareness is enabled
object A $objectDefinitionHandler = null (line 62)
  • var: reference to the handler for PHP object values
int $serverError = -1 (line 54)
  • var: Server error code
string $serverErrorString = '' (line 56)
  • var: Server error string
boolean $tokenizeParamsArray = false (line 52)
  • var: True if params array is to be tokenized

Inherited Variables

Inherited from php_http_server_generic

php_http_server_generic::$events
php_http_server_generic::$httpStatusCodes
php_http_server_generic::$protocol
php_http_server_generic::$protocolVersion
php_http_server_generic::$statusCode
Methods
Constructor dom_xmlrpc_server (line 71)

Constructor

dom_xmlrpc_server dom_xmlrpc_server ([object A $customMethods = null], [boolean $postData = null])
  • object A $customMethods: reference to a mapping of custom method handlers
  • boolean $postData: True if onPost is to be immediately called
addCustomMethods (line 142)

Adds user defined methods to the method map

void addCustomMethods (object A $customMethods)
  • object A $customMethods: map of custom methods
addMappedMethods (line 172)

Adds a map of user defined method to the method map

void addMappedMethods (object A &$methodmap, array $methodNameList)
  • object A &$methodmap: map of custom methods
  • array $methodNameList: A list of method names
addMethod (line 162)

Adds a single user defined method to the method map

void addMethod (array $method)
  • array $method: An array of custom methods
addMethods (line 152)

Adds user defined methods to the method map

void addMethods (array $methodsArray)
  • array $methodsArray: An array of custom methods
addSystemMethods (line 106)

Adds the default XML-RPC system methods to the method map

void addSystemMethods ()
buildFault (line 407)

Builds an XML-RPC fault

  • return: The XML-RPC fault
mixed buildFault (object A $response)
  • object A $response: reference to the method response data
buildMethodResponse (line 376)

Builds a method response

  • return: The method response
mixed buildMethodResponse (object A $response)
  • object A $response: reference to the method response data
buildResponse (line 360)

Builds a method response or fault

  • return: The method response or fault
mixed &buildResponse (object A &$response)
  • object A &$response: reference to the method response data
getCapabilities (line 222)

XML-RPC defined method: delineates what XML-RPC services are provided by the server

  • return: The XML-RPC services provided by the server
array getCapabilities ()
handleMethodNotFound (line 333)

Default handler for a missing method

  • return: A fault or user defined data
mixed &handleMethodNotFound (string $methodName, mixed &$params)
  • string $methodName: The method name
  • mixed &$params: The method params
invokeMethod (line 295)

Invokes the method(s) in the XML request

  • return: The method response
mixed &invokeMethod (string $xmlText)
  • string $xmlText: The XML text of the request
isError (line 387)

Determines whether an error has occurred

  • return: True if an error has occurred
boolean isError ()
listMethods (line 194)

XML-RPC defined method: lists all available methods

  • return: A list of method names
array listMethods ()
methodHelp (line 213)

XML-RPC defined method: returns help on the specified method

  • return: Help on the method
string methodHelp (string $name)
  • string $name: The method name
methodSignature (line 203)

XML-RPC defined method: returns the signature of the specified method

  • return: The method signature
array methodSignature (string $name)
  • string $name: The method name
multicall (line 243)

Handles multiple method calls in a single request

  • return: An array of method responses
array &multicall (array &$myArray)
  • array &$myArray: An array of method calls
onPost (line 283)

Handles the POSTing of data to the server

void onPost (string $postData)
  • string $postData: The POST data
onWrongRequestMethod (line 459)

Raises fault if POST is not used for method request

void onWrongRequestMethod ()
parseRequest (line 435)

Parses the method request

  • return: The method response document
mixed &parseRequest (string $xmlText)
  • string $xmlText: The text of the method request
raiseFault (line 395)

Raises an XML-RPC fault

  • return: XML-RPC fault
object An &raiseFault ()
setHeaders (line 86)

Sets the headers for the client connection

void setHeaders ()

Redefinition of:
php_http_server_generic::setHeaders()
setHTTPEvents (line 94)

Sets the default HTTP event handling

void setHTTPEvents ()
setMethodNotFoundHandler (line 351)

Sets the handler for a missing method

void setMethodNotFoundHandler (object A $method)
  • object A $method: reference to the method not found handler
setObjectAwareness (line 418)

Sets object awareness to the specified value

void setObjectAwareness (boolean $truthVal)
  • boolean $truthVal: True if object awareness is to be enabled
setObjectDefinitionHandler (line 426)

Sets the handler for object handling

void setObjectDefinitionHandler (object The $handler)
  • object The $handler: handler for object handling
tokenizeParams (line 180)

Specifies whether params should be tokenized

void tokenizeParams (boolean $truthVal)
  • boolean $truthVal: True if params should be tokenized

Inherited Methods

Inherited From php_http_server_generic

php_http_server_generic::php_http_server_generic()
php_http_server_generic::defaultDebugHandler()
php_http_server_generic::defaultHTTPHandler()
php_http_server_generic::fireEvent()
php_http_server_generic::fireHTTPEvent()
php_http_server_generic::getDebug()
php_http_server_generic::getHeaders()
php_http_server_generic::receive()
php_http_server_generic::respond()
php_http_server_generic::setDebug()
php_http_server_generic::setHeader()
php_http_server_generic::setHeaders()
php_http_server_generic::setHTTPEvent()
php_http_server_generic::setProtocolVersion()
php_http_server_generic::writeDebug()

Documentation generated on Fri, 4 Mar 2005 13:56:06 +1000 by phpDocumentor 1.3.0RC3