4. xmlrpcresp

This class is used to contain responses to XML-RPC requests. A server method handler will construct an xmlrpcresp and pass it as a return value. This same value will be returned by the result of an invocation of the send method of the xmlrpc_client class.

4.1. Creation

$resp = new xmlrpcresp($xmlrpcval);

$resp = new xmlrpcresp(0,  

The first syntax is used when execution has happened without difficulty: $xmlrpcval is an xmlrpcval value with the result of the method execution contained in it. Alternatively it can be a string containing the xml serialization of the single xml-rpc value result of method execution.

The second type of constructor is used in case of failure. errcode and err_string are used to provide indication of what has gone wrong. See xmlrpc_server for more information on passing error codes.

4.2. Methods

4.2.1. faultCode

$fn = $resp->faultCode();

Returns the integer fault code return from the XML-RPC response. A zero value indicates success, any other value indicates a failure response.

4.2.2. faultString

$fs = $resp->faultString();

Returns the human readable explanation of the fault indicated by $resp->faultCode().

4.2.3. value

$xmlrpcVal = $resp->value();

Returns an xmlrpcval object containing the return value sent by the server. If the response's faultCode is non-zero then the value returned by this method should not be used (it may not even be an object).

Note: if the xmlrpcresp instance in question has been created by an xmlrpc_client object whose return_type was set to 'phpvals', then a plain php value will be returned instead of an xmlrpcval object. If the return_type was set to xml, an xml string will be returned (see the return_type var above for more details).

4.2.4. serialize

$outString = $resp->serialize();

Returns an XML string representation of the response.