xmlrpcmsg Class Reference

Public Member Functions
	__construct ($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')

Public Attributes
	$payload
	$methodname
	$params =array()
	$debug =0
	$content_type = 'text/xml'

Detailed Description

Definition at line 2068 of file xmlrpc.inc.

Constructor & Destructor Documentation

__construct()

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

Parameters

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

Definition at line 2080 of file xmlrpc.inc.

Member Function Documentation

addParam()

xmlrpcmsg::addParam

(

$par

)

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

Parameters

xmlrpcval

$par

Returns

boolean false on failure @access public

Definition at line 2177 of file xmlrpc.inc.

createPayload()

xmlrpcmsg::createPayload

(

$charset_encoding = ''

)

@access private

Definition at line 2126 of file xmlrpc.inc.

getNumParams()

xmlrpcmsg::getNumParams

(

)

Returns the number of parameters in the messge.

Returns

integer the number of parameters currently set @access public

Definition at line 2204 of file xmlrpc.inc.

getParam()

xmlrpcmsg::getParam

(

$i

)

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

Parameters

integer

$i

the index of the parameter to fetch (zero based)

Returns

xmlrpcval the i-th parameter @access public

Definition at line 2197 of file xmlrpc.inc.

kindOf()

xmlrpcmsg::kindOf

(

)

@access private

Definition at line 2118 of file xmlrpc.inc.

method()

xmlrpcmsg::method

(

$meth = ''

)

Gets/sets the xmlrpc method to be invoked

Parameters

string

$meth

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

Returns

string the method that will be invoked @access public

Definition at line 2151 of file xmlrpc.inc.

parseResponse()

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

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

Parameters

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'

Returns

xmlrpcresp @access public

Definition at line 2467 of file xmlrpc.inc.

parseResponseFile()

& 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. @access public

Returns

xmlrpcresp

Definition at line 2213 of file xmlrpc.inc.

parseResponseHeaders()

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

Parses HTTP headers and separates them from data. @access private

Definition at line 2229 of file xmlrpc.inc.

serialize()

xmlrpcmsg::serialize

(

$charset_encoding = ''

)

Returns xml representation of the message. XML prologue included

Returns

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

Definition at line 2165 of file xmlrpc.inc.

xml_footer()

xmlrpcmsg::xml_footer

(

)

@access private

Definition at line 2110 of file xmlrpc.inc.

xml_header()

xmlrpcmsg::xml_header

(

$charset_encoding = ''

)

@access private

Definition at line 2095 of file xmlrpc.inc.

Member Data Documentation

$content_type

xmlrpcmsg::$content_type = 'text/xml'

Definition at line 2074 of file xmlrpc.inc.

$debug

xmlrpcmsg::$debug =0

Definition at line 2073 of file xmlrpc.inc.

$methodname

xmlrpcmsg::$methodname

Definition at line 2071 of file xmlrpc.inc.

$params

xmlrpcmsg::$params =array()

Definition at line 2072 of file xmlrpc.inc.

$payload

xmlrpcmsg::$payload

Definition at line 2070 of file xmlrpc.inc.

---

The documentation for this class was generated from the following file:

• xmlrpc/lib/xmlrpc.inc