Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Unknown

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class xmlrpc_server

Description
Description | Variables (details) | Methods (details)

Located in /phpxmlrpc/xmlrpcs.php (line 385) 

Class xmlrpc_server
Variable Summary
Description | Variables (details) | Methods (details)
Variable mixed $accepted_charset_encodings
Variable mixed $accepted_compression
Variable mixed $allow_system_funcs
Variable mixed $compress_response
Variable mixed $debug
Variable mixed $debug_info
Variable mixed $dmap
Variable mixed $functions_parameters_type
Variable mixed $response_charset_encoding
Method Summary
Description | Variables (details) | Methods (details)
Constructor xmlrpc_server xmlrpc_server ([ $dispMap = null], [ $serviceNow = true], array $dispmap, boolean $servicenow)
Method void add_to_map (string $methodname, string $function, array $sig, [string $doc = ''])
Method void echoInput ()
Method xmlrpcresp execute (mixed $m, [array $params = null], [array $paramtypes = null])
Method string serializeDebug ([string $charset_encoding = ''])
Method void service ([string $data = null])
Method void setDebug (integer $in)
Method void xml_header ([ $charset_encoding = ''])
Variables
Description | Variables (details) | Methods (details)
mixed $accepted_charset_encodings = array() (line 410)
mixed $accepted_compression = array() (line 406)

List of http compression methods accepted by the server for requests.

NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib

mixed $allow_system_funcs = true (line 408)
mixed $compress_response = false (line 401)

When set to true, it will enable HTTP compression of the response, in case the client has declared its support for compression in the request.

mixed $debug = 1 (line 396)
mixed $debug_info = '' (line 422)
mixed $dmap = array() (line 388)
mixed $functions_parameters_type = 'xmlrpcvals' (line 394)

Defines how functions in dmap will be invokde: either using an xmlrpc msg object or plain php values.

valid strings are 'xmlrpcvals' or 'phpvals'

mixed $response_charset_encoding = 'UTF-8' (line 420)

charset encoding to be used for response.

NB: if we can, we will convert the generated response from internal_encoding to the intended one. can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled), null (leave unspecified in response, convert output stream to US_ASCII), 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed), or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway). NB: pretty dangerous if you accept every charset and do not have mbstring enabled)

Methods
Description | Variables (details) Methods (details)
Constructor xmlrpc_server (line 428)
xmlrpc_server xmlrpc_server ([ $dispMap = null], [ $serviceNow = true], array $dispmap, boolean $servicenow)
  • array $dispmap: the dispatch map withd efinition of exposed services
  • boolean $servicenow: set to false to prevent the server from runnung upon construction
  • $dispMap
  • $serviceNow
add_to_map (line 602)

Add a method to the dispatch map

void add_to_map (string $methodname, string $function, array $sig, [string $doc = ''])
  • string $methodname: the name with which the method will be made available
  • string $function: the php function that will get invoked
  • array $sig: the array of valid method signatures
  • string $doc: method documentation
echoInput (line 1071)

A debugging routine: just echoes back the input packet as a string value

DEPRECATED!

void echoInput ()
execute (line 915)

Execute a method invoked by the client, checking parameters used

xmlrpcresp execute (mixed $m, [array $params = null], [array $paramtypes = null])
  • mixed $m: either an xmlrpcmsg obj or a method name
  • array $params: array with method parameters as php types (if m is method name only)
  • array $paramtypes: array with xmlrpc types of method parameters (if m is method name only)
serializeDebug (line 483)

Return a string with the serialized representation of all debug info

  • return: an XML comment (or two)
string serializeDebug ([string $charset_encoding = ''])
  • string $charset_encoding: the target charset encoding for the serialization
service (line 509)

Execute the xmlrpc request, printing the response

void service ([string $data = null])
  • string $data: the request body. If null, the http POST request will be examined
setDebug (line 473)

Set debug level of server.

void setDebug (integer $in)
  • integer $in: debug lvl: determines info added to xmlrpc responses (as xml comments)
    1. = no debug info,
    2. = msgs set from user with debugmsg(),
    3. = add complete xmlrpc request (headers and body),
    4. = add also all processing warnings happened during method processing
    (NB: this involves setting a custom error handler, and might interfere with the standard processing of the php function exposed as method. In particular, triggering an USER_ERROR level error will not halt script execution anymore, but just end up logged in the xmlrpc response) Note that info added at elevel 2 and 3 will be base64 encoded
xml_header (line 1055)
void xml_header ([ $charset_encoding = ''])
  • $charset_encoding
Documentation generated on Mon, 05 Mar 2007 21:32:59 +0000 by phpDocumentor 1.3.1