Docs For Class xmlrpcresp

Class Overview

Located in /blogs/inc/_ext/xmlrpc/_xmlrpc.inc.php [line 1836]

Property Summary

mixed	$content_type
mixed	$errno
mixed	$errstr
mixed	$hdrs
mixed	$payload
mixed	$raw_data
mixed	$val
mixed	$valtyp
mixed	$_cookies

[ Top ]

Method Summary

xmlrpcresp	xmlrpcresp()
array	cookies()	Returns an array with the cookies received from the server.
integer	faultCode()	Returns the error code of the response.
string	faultString()	Returns the error code of the response.
string	serialize()	Returns xml representation of the response. XML prologue not included
mixed	value()	Returns the value received by the server.

[ Top ]

Properties

mixed $content_type = 'text/xml' [line 1845]

[ Top ]

mixed $errno = 0 [line 1840]

[ Top ]

mixed $errstr = '' [line 1841]

[ Top ]

mixed $hdrs = array() [line 1843]

[ Top ]

mixed $payload [line 1842]

[ Top ]

mixed $raw_data = '' [line 1846]

[ Top ]

mixed $val = 0 [line 1838]

[ Top ]

mixed $valtyp [line 1839]

[ Top ]

mixed $_cookies = array() [line 1844]

[ Top ]

Methods

Constructor xmlrpcresp [line 1858]

xmlrpcresp xmlrpcresp(
mixed
$val, [integer
$fcode = 0], [string
$fstr = ''], [string
$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'

Information Tags:

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...

[ Top ]

cookies [line 1937]

array 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

API Tags:

Return:	array of cookies received from the server
Access:	public

[ Top ]

faultCode [line 1901]

integer faultCode(
)

Returns the error code of the response.

API Tags:

Return:	the error code of this response (0 for not-error responses)
Access:	public

[ Top ]

faultString [line 1911]

string faultString(
)

Returns the error code of the response.

API Tags:

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

[ Top ]

serialize [line 1948]

string serialize(
[string
$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

API Tags:

Return:	the xml representation of the response
Access:	public

[ Top ]

value [line 1921]

mixed value(
)

Returns the value received by the server.

API Tags:

Return:	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

[ Top ]

Multilingual multiuser multiblog engine

Class: xmlrpcresp

Class xmlrpcresp

Packages

Tutorials/Manuals

Classes

Files