2. xmlrpcmsg

This class provides a representation for a request to an XML-RPC server. A client sends an xmlrpcmsg to a server, and receives back an xmlrpcresp (see xmlrpc_client->send).

2.1. Creation

The constructor takes the following forms:

$msg = new xmlrpcmsg($methodName,  

Where methodName is a string indicating the name of the method you wish to invoke, and parameterArray is a simple php Array of xmlrpcval objects. Here's an example message to the US state name server:

$msg = new xmlrpcmsg("examples.getStateName", array(new xmlrpcval(23, "int")));

This example requests the name of state number 23. For more information on xmlrpcval objects, see xmlrpcval.

Note that the parameterArray parameter is optional and can be omitted for methods that take no input parameters or if you plan to add parameters one by one.

2.2. Methods

2.2.1. addParam

$ok = $msg->addParam($xmlrpcVal);

Adds the xmlrpcval xmlrpcVal to the parameter list for this method call. Returns TRUE or FALSE on error.

2.2.2. getNumParams

$n = $msg->getNumParams();

Returns the number of parameters attached to this message.

2.2.3. getParam

$xmlrpcVal = $msg->getParam($n);

Gets the nth parameter in the message (with the index zero-based). Use this method in server implementations to retrieve the values sent by the client.

2.2.4. method

$methName = $msg->method();


Gets or sets the method contained in the XML-RPC message.

2.2.5. parseResponse

$response = $msg->parseResponse($xmlString); 

Given an incoming XML-RPC server response contained in the string $xmlString, this method constructs an xmlrpcresp response object and returns it, setting error codes as appropriate (see xmlrpc_client->send).

This method processes any HTTP/MIME headers it finds.

2.2.6. parseResponseFile

$response = $msg->parseResponseFile($fileHandle); 

Given an incoming XML-RPC server response on the open file handle fileHandle, this method reads the data and passes it to parseResponse.

This method is useful to construct responses from pre-prepared files (see files demo1.txt, demo2.txt, demo3.txt in this distribution). It processes any HTTP headers it finds.

2.2.7. serialize

$outString = $msg->serialize();

Returns the an XML string representing the XML-RPC message.