xmlrpcresp Class Reference

List of all members.

Public Member Functions
	xmlrpcresp ($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 1872 of file xmlrpc.inc.php.

---

Member Function Documentation

xmlrpcresp::xmlrpcresp	(	$	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'

Todo:

add check that $val / $fcode / $fstr is of correct type??? NB: as of now we do not do it, since it might be either an xmlrpcval or a plain php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...

Definition at line 1894 of file xmlrpc.inc.php.

References $val, and $valtyp.

xmlrpcresp::faultCode

(

)

Returns the error code of the response.

Returns:

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

Definition at line 1937 of file xmlrpc.inc.php.

xmlrpcresp::faultString

(

)

Returns the error code of the response.

Returns:

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

Definition at line 1947 of file xmlrpc.inc.php.

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 public

Definition at line 1957 of file xmlrpc.inc.php.

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 public

Definition at line 1973 of file xmlrpc.inc.php.

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 public

Todo:

try to build something serializable?

Definition at line 1984 of file xmlrpc.inc.php.

References $GLOBALS.

---

Member Data Documentation

xmlrpcresp::$val = 0

Definition at line 1874 of file xmlrpc.inc.php.

Referenced by xmlrpcresp().

xmlrpcresp::$valtyp

Definition at line 1875 of file xmlrpc.inc.php.

Referenced by xmlrpcresp().

xmlrpcresp::$errno = 0

Definition at line 1876 of file xmlrpc.inc.php.

xmlrpcresp::$errstr = ''

Definition at line 1877 of file xmlrpc.inc.php.

xmlrpcresp::$payload

Definition at line 1878 of file xmlrpc.inc.php.

xmlrpcresp::$hdrs = array()

Definition at line 1879 of file xmlrpc.inc.php.

xmlrpcresp::$_cookies = array()

Definition at line 1880 of file xmlrpc.inc.php.

xmlrpcresp::$content_type = 'text/xml'

Definition at line 1881 of file xmlrpc.inc.php.

xmlrpcresp::$raw_data = ''

Definition at line 1882 of file xmlrpc.inc.php.

---

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

• xmlrpc.inc.php