xmlrpcmsg Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	xmlrpcmsg ($meth, $pars=0)
	xml_header ($charset_encoding='')
	xml_footer ()
	kindOf ()
	createPayload ($charset_encoding='')
	method ($meth='')
	serialize ($charset_encoding='')
	addParam ($par)
	getParam ($i)
	getNumParams ()
&	parseResponseFile ($fp)
&	parseResponseHeaders (&$data, $headers_processed=false)
&	parseResponse ($data='', $headers_processed=false, $return_type='xmlrpcvals')
Öffentliche Attribute
	$payload
	$methodname
	$params = array()
	$debug = 0
	$content_type = 'text/xml'

---

Ausführliche Beschreibung

Definiert in Zeile 2069 der Datei xmlrpc.inc.

---

Dokumentation der Elementfunktionen

xmlrpcmsg::addParam

(

$

par

)

Add a parameter to the list of parameters to be used upon method invocation

Parameter:

xmlrpcval

$par

Rückgabe:

boolean false on failure public

Definiert in Zeile 2178 der Datei xmlrpc.inc.

Wird benutzt von xmlrpcmsg().

xmlrpcmsg::createPayload

(

$

charset_encoding = ''

)

private

Definiert in Zeile 2127 der Datei xmlrpc.inc.

Benutzt xml_footer() und xml_header().

Wird benutzt von serialize().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

xmlrpcmsg::getNumParams

(

)

Returns the number of parameters in the messge.

Rückgabe:

integer the number of parameters currently set public

Definiert in Zeile 2205 der Datei xmlrpc.inc.

xmlrpcmsg::getParam

(

$

i

)

Returns the nth parameter in the message. The index zero-based.

Parameter:

integer

$i the index of the parameter to fetch (zero based)

Rückgabe:

xmlrpcval the i-th parameter public

Definiert in Zeile 2198 der Datei xmlrpc.inc.

xmlrpcmsg::kindOf

(

)

private

Definiert in Zeile 2119 der Datei xmlrpc.inc.

xmlrpcmsg::method

(

$

meth = ''

)

Gets/sets the xmlrpc method to be invoked

Parameter:

string

$meth the method to be set (leave empty not to set it)

Rückgabe:

string the method that will be invoked public

Definiert in Zeile 2152 der Datei xmlrpc.inc.

& xmlrpcmsg::parseResponse	(	$	data = '',
		$	headers_processed = false,
		$	return_type = 'xmlrpcvals'
	)

Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.

Parameter:

	string	$data the xmlrpc response, eventually including http headers
	bool	$headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
	string	$return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'

Rückgabe:

xmlrpcresp public

Noch zu erledigen:

return an error msg if $data=='' ?

Noch zu erledigen:

echo something for user?

Noch zu erledigen:

we should test here if server sent an int and a string, and/or coerce them into such...

Definiert in Zeile 2473 der Datei xmlrpc.inc.

Benutzt $GLOBALS und parseResponseHeaders().

Wird benutzt von parseResponseFile().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

& xmlrpcmsg::parseResponseFile

(

$

fp

)

Given an open file handle, read all data available and parse it as axmlrpc response. NB: the file handle is not closed by this function. NNB: might have trouble in rare cases to work on network streams, as we check for a read of 0 bytes instead of feof($fp). But since checking for feof(null) returns false, we would risk an infinite loop in that case, because we cannot trust the caller to give us a valid pointer to an open file... public

Rückgabe:

xmlrpcresp

Noch zu erledigen:

add 2nd & 3rd param to be passed to ParseResponse() ???

Definiert in Zeile 2219 der Datei xmlrpc.inc.

Benutzt parseResponse().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

& xmlrpcmsg::parseResponseHeaders	(	&$	data,
		$	headers_processed = false
	)

Parses HTTP headers and separates them from data. private

Noch zu erledigen:

some other headers (the ones that allow a CSV list of values) do allow many values to be passed using multiple header lines. We should add content to $GLOBALS['_xh']['headers'][$header_name] instead of replacing it for those...

Noch zu erledigen:

with version 1 cookies, we should strip leading and trailing " chars

Noch zu erledigen:

version1 cookies might span multiple lines, thus breaking the parsing above

Definiert in Zeile 2235 der Datei xmlrpc.inc.

Benutzt $GLOBALS.

Wird benutzt von parseResponse().

xmlrpcmsg::serialize

(

$

charset_encoding = ''

)

Returns xml representation of the message. XML prologue included

Rückgabe:

string the xml representation of the message, xml prologue included public

Definiert in Zeile 2166 der Datei xmlrpc.inc.

Benutzt createPayload().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

xmlrpcmsg::xml_footer

(

)

private

Definiert in Zeile 2111 der Datei xmlrpc.inc.

Wird benutzt von createPayload().

xmlrpcmsg::xml_header

(

$

charset_encoding = ''

)

private

Definiert in Zeile 2096 der Datei xmlrpc.inc.

Wird benutzt von createPayload().

xmlrpcmsg::xmlrpcmsg	(	$	meth,
		$	pars = 0
	)

Parameter:

	string	$meth the name of the method to invoke
	array	$pars array of parameters to be paased to the method (xmlrpcval objects)

Definiert in Zeile 2081 der Datei xmlrpc.inc.

Benutzt addParam().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Datenelemente

xmlrpcmsg::$content_type = 'text/xml'

Definiert in Zeile 2075 der Datei xmlrpc.inc.

xmlrpcmsg::$debug = 0

Definiert in Zeile 2074 der Datei xmlrpc.inc.

xmlrpcmsg::$methodname

Definiert in Zeile 2072 der Datei xmlrpc.inc.

xmlrpcmsg::$params = array()

Definiert in Zeile 2073 der Datei xmlrpc.inc.

xmlrpcmsg::$payload

Definiert in Zeile 2071 der Datei xmlrpc.inc.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• lib/xmlrpc.inc