Fonctions membres publiques

xmlrpc_server ($dispMap=null, $serviceNow=true)
setDebug ($in)
serializeDebug ($charset_encoding='')
service ($data=null, $return_payload=false)
add_to_map ($methodname, $function, $sig=null, $doc='')
verifySignature ($in, $sig)
parseRequestHeaders (&$data, &$req_encoding, &$resp_encoding, &$resp_compression)
parseRequest ($data, $req_encoding='')
execute ($m, $params=null, $paramtypes=null)
debugmsg ($string)
xml_header ($charset_encoding='')
echoInput ()

Attributs publics

$dmap = array()
array defining php functions exposed as xmlrpc methods by this server
$functions_parameters_type = 'xmlrpcvals'
$debug = 1
controls wether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3
$compress_response = false
$accepted_compression = array()
$allow_system_funcs = true
shall we serve calls to system.* methods?
$accepted_charset_encodings = array()
list of charset encodings natively accepted for requests
$response_charset_encoding = ''
$debug_info = ''
storage for internal debug info
$user_data = null
extra data passed at runtime to method handling functions. Used only by EPI layer

Documentation des fonctions membres

xmlrpc_server::add_to_map	(	$	methodname,
		$	function,
		$	sig = `null`,
		$	doc = `''`
	)

Add a method to the dispatch map

Paramètres:

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 public

Références $doc.

xmlrpc_server::debugmsg ( $ string )

add a string to the 'internal debug message' (separate from 'user debug message')

Paramètres:

string $strings private

Référencé par parseRequest(), parseRequestHeaders(), et service().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::echoInput ( )

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

Références $GLOBALS.

xmlrpc_server::execute	(	$	m,
		$	params = `null`,
		$	paramtypes = `null`
	)

Execute a method invoked by the client, checking parameters used

Paramètres:

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)

Renvoie:: xmlrpcresp private

Références $dmap, $GLOBALS, $params, functions_parameters_type, et verifySignature().

Référencé par parseRequest().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::parseRequest	(	$	data,
		$	req_encoding = `''`
	)

Parse an xml chunk containing an xmlrpc request and execute the corresponding php function registered with the server

Paramètres:

string	$data	the xml request
string	$req_encoding	(optional) the charset encoding of the xml request

Renvoie:: xmlrpcresp private

this will fail on PHP 5 if charset is not specified in the xml prologue,

Références $data, $GLOBALS, $i, debugmsg(), elseif, execute(), et functions_parameters_type.

Référencé par service().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::parseRequestHeaders	(	&$	data,
		&$	req_encoding,
		&$	resp_encoding,
		&$	resp_compression
	)

Parse http headers received along with xmlrpc request. If needed, inflate request

Renvoie:: null on success or an xmlrpcresp private

Références $data, $GLOBALS, $name, debugmsg(), et elseif.

Référencé par service().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::serializeDebug ( $ charset_encoding = '' )

Return a string with the serialized representation of all debug info

Paramètres:

string $charset_encoding the target charset encoding for the serialization

Renvoie:: string an XML comment (or two)

Références $GLOBALS, et xmlrpc_encode_entitites().

Référencé par service().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::service	(	$	data = `null`,
		$	return_payload = `false`
	)

Execute the xmlrpc request, printing the response

Paramètres:

string $data the request body. If null, the http POST request will be examined

Renvoie:: xmlrpcresp the response object (usually not used by caller...) public

Références $data, $GLOBALS, debugmsg(), elseif, parseRequest(), parseRequestHeaders(), serializeDebug(), et xml_header().

Référencé par xmlrpc_server().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::setDebug ( $ in )

Set debug level of server.

Paramètres:

integer $in debug lvl: determines info added to xmlrpc responses (as xml comments) 0 = no debug info, 1 = msgs set from user with debugmsg(), 2 = add complete xmlrpc request (headers and body), 3 = 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 public

xmlrpc_server::verifySignature	(	$	in,
		$	sig
	)

Verify type and number of parameters received against a list of known signatures

Paramètres:

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

Références $GLOBALS, et $n.

Référencé par execute().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::xml_header ( $ charset_encoding = '' )

private

Référencé par service().

Voici le graphe d'appel pour cette fonction :

xmlrpc_server::xmlrpc_server	(	$	dispMap = `null`,
		$	serviceNow = `true`
	)

Paramètres:

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

Références service().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

xmlrpc_server::$accepted_charset_encodings = array()

list of charset encodings natively accepted for requests

xmlrpc_server::$accepted_compression = array()

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

xmlrpc_server::$allow_system_funcs = true

shall we serve calls to system.* methods?

xmlrpc_server::$compress_response = false

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.

xmlrpc_server::$debug = 1

controls wether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3

xmlrpc_server::$debug_info = ''

storage for internal debug info

xmlrpc_server::$dmap = array()

array defining php functions exposed as xmlrpc methods by this server

Référencé par execute().

xmlrpc_server::$functions_parameters_type = 'xmlrpcvals'

Defines how functions in dmap will be invokde: either using an xmlrpc msg object or plain php values. valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'

xmlrpc_server::$response_charset_encoding = ''

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)

xmlrpc_server::$user_data = null

extra data passed at runtime to method handling functions. Used only by EPI layer

La documentation de cette classe a été générée à partir du fichier suivant :

xmlrpcs.php

Référence de la classe xmlrpc_server

Fonctions membres publiques

Attributs publics

Documentation des fonctions membres

Documentation des données membres