XML-RPC for PHP: version 1.1
Prev	Chapter 5. Class documentation	Next

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

Creation

The constructor takes the following form:

$msg=new xmlrpcmsg($methodName, $parameterArray);

Where $methodName is a string indicating the name of the method you wish to invoke, and $parameterArray is a simple 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.

Methods

serialize

$outString=$msg->serialize();

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

addParam

$msg->addParam($xmlrpcVal);

Adds the xmlrpcval $xmlrpcVal to the parameter list for this method call.

getParam

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

Gets the $nth parameter in the message. Use this method in server implementations. Returns the undef value if no such parameter exists.

getNumParams

$n=$msg->getNumParams();

Returns the number of parameters attached to this message.

method

$methName=$msg->method();

$msg->method($methName);

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

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.

parseResponseFile

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

Given an incoming XML-RPC server response on the 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.