xmlrpc_server Klassenreferenz
Öffentliche Methoden | |
| 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=false, $sigdoc=false) | |
| 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 () | |
Öffentliche Attribute | |
| $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 | |
Ausführliche Beschreibung
Definiert in Zeile 433 der Datei xmlrpcs.inc.
Dokumentation der Elementfunktionen
| xmlrpc_server::add_to_map | ( | $ | methodname, | |
| $ | function, | |||
| $ | sig = null, |
|||
| $ | doc = false, |
|||
| $ | sigdoc = false | |||
| ) |
Add a method to the dispatch map
- Parameter:
-
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 array $sigdoc the array of valid method signatures docs (one string per param, one for return type) public
Definiert in Zeile 680 der Datei xmlrpcs.inc.
| xmlrpc_server::debugmsg | ( | $ | string | ) |
add a string to the 'internal debug message' (separate from 'user debug message')
- Parameter:
-
string $strings private
Definiert in Zeile 1168 der Datei xmlrpcs.inc.
Wird benutzt von parseRequest(), parseRequestHeaders() und service().
| xmlrpc_server::echoInput | ( | ) |
A debugging routine: just echoes back the input packet as a string value DEPRECATED!
Definiert in Zeile 1192 der Datei xmlrpcs.inc.
Benutzt $GLOBALS.
| xmlrpc_server::execute | ( | $ | m, | |
| $ | params = null, |
|||
| $ | paramtypes = null | |||
| ) |
Execute a method invoked by the client, checking parameters used
- Parameter:
-
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)
- Rückgabe:
- xmlrpcresp private
Definiert in Zeile 1013 der Datei xmlrpcs.inc.
Benutzt $dmap, $GLOBALS und verifySignature().
Wird benutzt von parseRequest().
| xmlrpc_server::parseRequest | ( | $ | data, | |
| $ | req_encoding = '' | |||
| ) |
Parse an xml chunk containing an xmlrpc request and execute the corresponding php function registered with the server
- Parameter:
-
string $data the xml request string $req_encoding (optional) the charset encoding of the xml request
- Rückgabe:
- xmlrpcresp private
this will fail on PHP 5 if charset is not specified in the xml prologue,
- Noch zu erledigen:
- use an ampty string for php 5 ???
Definiert in Zeile 891 der Datei xmlrpcs.inc.
Benutzt $GLOBALS, debugmsg() und execute().
Wird benutzt von service().
| xmlrpc_server::parseRequestHeaders | ( | &$ | data, | |
| &$ | req_encoding, | |||
| &$ | resp_encoding, | |||
| &$ | resp_compression | |||
| ) |
Parse http headers received along with xmlrpc request. If needed, inflate request
- Rückgabe:
- null on success or an xmlrpcresp private
- Noch zu erledigen:
- we should parse q=0.x preferences instead of getting first charset specified...
- Noch zu erledigen:
- check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
Definiert in Zeile 768 der Datei xmlrpcs.inc.
Benutzt $GLOBALS und debugmsg().
Wird benutzt von service().
| xmlrpc_server::serializeDebug | ( | $ | charset_encoding = '' |
) |
Return a string with the serialized representation of all debug info
- Parameter:
-
string $charset_encoding the target charset encoding for the serialization
- Rückgabe:
- string an XML comment (or two)
Definiert in Zeile 534 der Datei xmlrpcs.inc.
Benutzt $GLOBALS und xmlrpc_encode_entitites().
Wird benutzt von service().
| xmlrpc_server::service | ( | $ | data = null, |
|
| $ | return_payload = false | |||
| ) |
Execute the xmlrpc request, printing the response
- Parameter:
-
string $data the request body. If null, the http POST request will be examined
- Rückgabe:
- xmlrpcresp the response object (usually not used by caller...) public
Definiert in Zeile 563 der Datei xmlrpcs.inc.
Benutzt $GLOBALS, debugmsg(), parseRequest(), parseRequestHeaders(), serializeDebug() und xml_header().
Wird benutzt von xmlrpc_server().
| xmlrpc_server::setDebug | ( | $ | in | ) |
Set debug level of server.
- Parameter:
-
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
Definiert in Zeile 524 der Datei xmlrpcs.inc.
| xmlrpc_server::verifySignature | ( | $ | in, | |
| $ | sig | |||
| ) |
Verify type and number of parameters received against a list of known signatures
- Parameter:
-
array $in array of either xmlrpcval objects or xmlrpc type definitions array $sig array of known signatures to match against private
Definiert in Zeile 702 der Datei xmlrpcs.inc.
Benutzt $GLOBALS.
Wird benutzt von execute().
| xmlrpc_server::xml_header | ( | $ | charset_encoding = '' |
) |
| xmlrpc_server::xmlrpc_server | ( | $ | dispMap = null, |
|
| $ | serviceNow = true | |||
| ) |
- Parameter:
-
array $dispmap the dispatch map withd efinition of exposed services boolean $servicenow set to false to prevent the server from runnung upon construction
Definiert in Zeile 478 der Datei xmlrpcs.inc.
Benutzt service().
Dokumentation der Datenelemente
| xmlrpc_server::$accepted_charset_encodings = array() |
list of charset encodings natively accepted for requests
Definiert in Zeile 458 der Datei xmlrpcs.inc.
| 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
Definiert in Zeile 454 der Datei xmlrpcs.inc.
| xmlrpc_server::$allow_system_funcs = true |
| 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.
Definiert in Zeile 449 der Datei xmlrpcs.inc.
| 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
Definiert in Zeile 444 der Datei xmlrpcs.inc.
| xmlrpc_server::$debug_info = '' |
| xmlrpc_server::$dmap = array() |
array defining php functions exposed as xmlrpc methods by this server
Definiert in Zeile 436 der Datei xmlrpcs.inc.
Wird benutzt von 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'
Definiert in Zeile 442 der Datei xmlrpcs.inc.
| 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)
Definiert in Zeile 468 der Datei xmlrpcs.inc.
| xmlrpc_server::$user_data = null |
extra data passed at runtime to method handling functions. Used only by EPI layer
Definiert in Zeile 472 der Datei xmlrpcs.inc.
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
- lib/xmlrpcs.inc
