xmlrpcresp Class Reference

Public Member Functions
	__construct ($val, $fcode=0, $fstr='', $valtyp='')
	faultCode ()
	faultString ()
	value ()
	cookies ()
	serialize ($charset_encoding='')

Public Attributes
	$val = 0
	$valtyp
	$errno = 0
	$errstr = ''
	$payload
	$hdrs = array()
	$_cookies = array()
	$content_type = 'text/xml'
	$raw_data = ''

Detailed Description

Definition at line 1910 of file xmlrpc.inc.

Constructor & Destructor Documentation

__construct()

xmlrpcresp::__construct	(		$val,
			$fcode = 0,
			$fstr = '',
			$valtyp = ''
	)

Parameters

mixed	$val	either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
integer	$fcode	set it to anything but 0 to create an error response
string	$fstr	the error string, in case of an error response
string	$valtyp	either 'xmlrpcvals', 'phpvals' or 'xml'

Definition at line 1932 of file xmlrpc.inc.

Member Function Documentation

cookies()

xmlrpcresp::cookies

(

)

Returns an array with the cookies received from the server. Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...) with attributes being e.g. 'expires', 'path', domain'. NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) are still present in the array. It is up to the user-defined code to decide how to use the received cookies, and wheter they have to be sent back with the next request to the server (using xmlrpc_client::setCookie) or not

Returns

array array of cookies received from the server @access public

Definition at line 2011 of file xmlrpc.inc.

faultCode()

xmlrpcresp::faultCode

(

)

Returns the error code of the response.

Returns

integer the error code of this response (0 for not-error responses) @access public

Definition at line 1975 of file xmlrpc.inc.

faultString()

xmlrpcresp::faultString

(

)

Returns the error code of the response.

Returns

string the error string of this response ('' for not-error responses) @access public

Definition at line 1985 of file xmlrpc.inc.

serialize()

xmlrpcresp::serialize

(

$charset_encoding = ''

)

Returns xml representation of the response. XML prologue not included

Parameters

string

$charset_encoding

the charset to be used for serialization. if null, US-ASCII is assumed

Returns

string the xml representation of the response @access public

Definition at line 2022 of file xmlrpc.inc.

value()

xmlrpcresp::value

(

)

Returns the value received by the server.

Returns

mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects @access public

Definition at line 1995 of file xmlrpc.inc.

Member Data Documentation

$_cookies

xmlrpcresp::$_cookies = array()

Definition at line 1918 of file xmlrpc.inc.

$content_type

xmlrpcresp::$content_type = 'text/xml'

Definition at line 1919 of file xmlrpc.inc.

$errno

xmlrpcresp::$errno = 0

Definition at line 1914 of file xmlrpc.inc.

$errstr

xmlrpcresp::$errstr = ''

Definition at line 1915 of file xmlrpc.inc.

$hdrs

xmlrpcresp::$hdrs = array()

Definition at line 1917 of file xmlrpc.inc.

$payload

xmlrpcresp::$payload

Definition at line 1916 of file xmlrpc.inc.

$raw_data

xmlrpcresp::$raw_data = ''

Definition at line 1920 of file xmlrpc.inc.

$val

xmlrpcresp::$val = 0

Definition at line 1912 of file xmlrpc.inc.

$valtyp

xmlrpcresp::$valtyp

Definition at line 1913 of file xmlrpc.inc.

---

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

• xmlrpc/lib/xmlrpc.inc