[ Index ]

PHP Cross Reference of Nucleus CMS 3.64

title

Body

[close]

/nucleus3.64/nucleus/libs/ -> xmlrpcs.inc.php (summary)

(no description)

File Size: 1173 lines (39 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

xmlrpc_server:: (12 methods):
  xmlrpc_server()
  setDebug()
  serializeDebug()
  service()
  add_to_map()
  verifySignature()
  parseRequestHeaders()
  parseRequest()
  execute()
  debugmsg()
  xml_header()
  echoInput()

Defines 12 functions

  _xmlrpcs_getCapabilities()
  _xmlrpcs_listMethods()
  _xmlrpcs_methodSignature()
  _xmlrpcs_methodHelp()
  _xmlrpcs_multicall_error()
  _xmlrpcs_multicall_do_call()
  _xmlrpcs_multicall_do_call_phpvals()
  _xmlrpcs_multicall()
  _xmlrpcs_errorHandler()
  xmlrpc_debugmsg()

Class: xmlrpc_server  - X-Ref

xmlrpc_server($dispMap=null, $serviceNow=true)   X-Ref

param: array $dispmap the dispatch map withd efinition of exposed services
param: boolean $servicenow set to false to prevent the server from runnung upon construction

setDebug($in)   X-Ref
Set debug level of server.

param: integer $in debug lvl: determines info added to xmlrpc responses (as xml comments)

serializeDebug($charset_encoding='')   X-Ref
Return a string with the serialized representation of all debug info

param: string $charset_encoding the target charset encoding for the serialization
return: string an XML comment (or two)

service($data=null, $return_payload=false)   X-Ref
Execute the xmlrpc request, printing the response

param: string $data the request body. If null, the http POST request will be examined
return: xmlrpcresp the response object (usually not used by caller...)

add_to_map($methodname,$function,$sig=null,$doc='')   X-Ref
Add a method to the dispatch map

param: string $methodname the name with which the method will be made available
param: string $function the php function that will get invoked
param: array $sig the array of valid method signatures
param: string $doc method documentation

verifySignature($in, $sig)   X-Ref
Verify type and number of parameters received against a list of known signatures

param: array $in array of either xmlrpcval objects or xmlrpc type definitions
param: array $sig array of known signatures to match against

parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression)   X-Ref
Parse http headers received along with xmlrpc request. If needed, inflate request

return: null on success or an xmlrpcresp

parseRequest($data, $req_encoding='')   X-Ref
Parse an xml chunk containing an xmlrpc request and execute the corresponding
php function registered with the server

param: string $data the xml request
param: string $req_encoding (optional) the charset encoding of the xml request
return: xmlrpcresp

execute($m, $params=null, $paramtypes=null)   X-Ref
Execute a method invoked by the client, checking parameters used

param: mixed $m either an xmlrpcmsg obj or a method name
param: array $params array with method parameters as php types (if m is method name only)
param: array $paramtypes array with xmlrpc types of method parameters (if m is method name only)
return: xmlrpcresp

debugmsg($string)   X-Ref
add a string to the 'internal debug message' (separate from 'user debug message')

param: string $strings

xml_header($charset_encoding='')   X-Ref


echoInput()   X-Ref
A debugging routine: just echoes back the input packet as a string value
DEPRECATED!


Functions
Functions that are not part of a class:

_xmlrpcs_getCapabilities($server, $m=null)   X-Ref
No description

_xmlrpcs_listMethods($server, $m=null)   X-Ref
No description

_xmlrpcs_methodSignature($server, $m)   X-Ref
No description

_xmlrpcs_methodHelp($server, $m)   X-Ref
No description

_xmlrpcs_multicall_error($err)   X-Ref
No description

_xmlrpcs_multicall_do_call($server, $call)   X-Ref
No description

_xmlrpcs_multicall_do_call_phpvals($server, $call)   X-Ref
No description

_xmlrpcs_multicall($server, $m)   X-Ref
No description

_xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null)   X-Ref
Error handler used to track errors that occur during server-side execution of PHP code.
This allows to report back to the client whether an internal error has occurred or not
using an xmlrpc response object, instead of letting the client deal with the html junk
that a PHP execution error on the server generally entails.

NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.


xmlrpc_debugmsg($m)   X-Ref
Add a string to the debug info that can be later seralized by the server
as part of the response message.
Note that for best compatbility, the debug string should be encoded using
the $GLOBALS['xmlrpc_internalencoding'] character set.

param: string $m



Generated: Mon May 2 16:14:08 2011 Cross-referenced by PHPXref 0.7.1