This is the basic class used to represent a client of an XML-RPC server.
The constructor has the following syntax:
Here's an example client set up to query Userland's XML-RPC server at betty.userland.com:
$client = new XML_RPC_Client("/RPC2", "betty.userland.com", 80); |
Note: The server_port parameter is optional, and if omitted will default to 80 when using HTTP and 443 when using HTTPS (see the "send" method below.)
This class supports the following methods.
This method takes the form:
Where $xmlrpc_message is an instance of XML_RPC_Message and $response is an instance of XML_RPC_Response (see XML_RPC_Response).
The $timeout is optional, and will be set to 0 (wait forever) if omitted. This timeout value is passed to fsockopen().
The server_method parameter is optional, and if omitted will default to 'http'. The only other valid value is 'https', which will use an SSL HTTP connection to connect to the remote server. Note that your PHP must have the "curl" extensions compiled in in order to use this feature. Note that when using SSL you should normally set your port number to 443, unless the SSL server you are contacting runs at any other port.
Warning |
PHP 4.0.2 or greater is required for SSL functionality. PHP 4.0.6 has a bug which prevents SSL working. |
If the value of $response is 0 rather than an XML_RPC_Response object, then this signifies an I/O error has occured. You can find out what the I/O error was from the values $client->errno() and $client->errstring().
In addition to low-level errors, the XML-RPC server you were querying may return an error in the XML_RPC_Response object. See XML_RPC_Response for details of how to handle these errors.
This method sets the username and password for authorizing the client to a server. With the default (HTTP) transport, this information is used for HTTP Basic authorization.
This method sets the optional certificate and passphrase used in SSL-enabled communication with a remote server (when the server_method is set to 'https' in the client's construction).
The certificate parameter must be the filename of a PEM formatted certificate. The passphrase parameter must contain the password required to use the certificate.
This requires the "curl" extensions to be compiled into your installation of PHP.
This method defines whether connections made to XML-RPC backends via HTTPS should verify the remote host's SSL certificate, and cause the connection to fail if the cert verification fails. $i should be a boolean value.
This method defines whether connections made to XML-RPC backends via HTTPS should verify the remote host's SSL certificate's common name (CN). By default, only the existence of a CN is checked. $i should be an integer value; 0 to not check the CN at all, 1 to merely check for its existence, and 2 to check that the CN on the certificate matches the hostname that is being connected to.
$debugOn is either 0 or 1 depending on whether you require the client to print debugging information to the browser. The default is not to output this information.
The debugging information includes the raw data returned from the XML-RPC server it was querying, and the PHP value the client attempts to create to represent the value returned by the server. This option can be very useful when debugging servers as it allows you to see exactly what the server returns.
This class provides a representation for a request to an XML-RPC server. A client sends an XML_RPC_Message to a server, and receives back an XML_RPC_Response.
The constructor takes the following form:
Where $methodName is a string indicating the name of the method you wish to invoke, and $parameterArray is a simple Array of XML_RPC_Value objects. Here's an example message to the US state name server:
require_once "XML/RPC.php"; $msg = new XML_RPC_Message("examples.getStateName", array(new XML_RPC_Value(23, "int"))); |
This example requests the name of state number 23. For more information on XML_RPC_Value objects, see XML_RPC_Value.
Gets the $nth parameter in the message. Use this method in server implementations. Returns the undef value if no such parameter exists.
Given an incoming XML-RPC server response contained in the string $xmlString, this method constructs an XML_RPC_Response response object and returns it, setting error codes as appropriate.
This method processes any HTTP/MIME headers it finds.
This class is used to contain responses to XML-RPC requests. A server method handler will construct an XML_RPC_Response 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 XML_RPC_Client class.
The first instance is used when execution has happened without difficulty: $xmlrpcval is an XML_RPC_Value value with the result of the method execution contained in it.
The second type of constructor is used in case of failure. $errcode and $errstring are used to provide indication of what has gone wrong. See XML_RPC_Server for more information on passing error codes.
Returns the integer fault code return from the XML-RPC response $resp. A zero value indicates success, any other value indicates a failure response.
This is where a lot of the hard work gets done. This class enables the creation and encapsulation of values for XML-RPC.
Ensure you've read the XML-RPC spec at http://www.xmlrpc.com/stories/storyReader$7 before reading on as it will make things clearer.
The XML_RPC_Value class can store arbitrarily complicated values using the following types: i4 int boolean string double dateTime.iso8601 base64 array struct. You should refer to the spec for more information on what each of these types mean.
The type i4 is accepted as a synonym for int. The value parsing code will always convert i4 to int: int is regarded by this implementation as the canonical name for this type.
Base 64 encoding is performed transparently to the caller when using this type. Therefore you ought to consider it as a "binary" data type, for use when you want to pass none 7-bit clean data. Decoding is also transparent.
The values true and 1 map to true. All other values (including the empty string) are converted to false.
The characters < > " and & are converted to their entity equivalents < > " and & for transport through XML-RPC. The current XML-RPC spec recommends only encoding < & but this implementation goes further, for reasons explained by the XML 1.0 recommendation.
TODO: ' entity not yet supported
The constructor is the normal way to create an XML_RPC_Value. The constructor can take these forms:
The first constructor creates an empty value, which must be altered using the methods addScalar(), addArray() or addStruct() before it can be used.
The second constructor creates a simple string value.
The third constructor is used to create a scalar value. The second parameter must be a name of an XML-RPC type. Examples:
$myInt = new XML_RPC_Value(1267, "int"); $myString= new XML_RPC_Value("Hello, World!", "string"); $myBool = new XML_RPC_Value(1, "boolean"); |
The fourth constructor form can be used to compose complex XML-RPC values. The first argument is either a simple array in the case of an XML-RPC array or an associative array in the case of a struct. The elements of the array must be XML_RPC_Value objects themselves. Examples:
$myArray = new XML_RPC_Value(array( new XML_RPC_Value("Tom"), new XML_RPC_Value("Dick"), new XML_RPC_Value("Harry")), "array"); $myStruct = new XML_RPC_Value(array( "name" => new XML_RPC_Value("Tom"), "age" => new XML_RPC_Value(34, "int"), "geek" => new XML_RPC_Value(1, "boolean")), "struct"); |
If $val is an empty XML_RPC_Value this method makes it a scalar value, and sets that value. If $val is already a scalar value, then no more scalars can be added and 0 is returned. If all went OK, 1 is returned.
There is a special case if $val is an array: the scalar value passedis appended to the array.
Turns an empty XML_RPC_Value into an array with contents as specified by $arrayVal. See the fourth constructor form for more information.
Turns an empty XML_RPC_Value into a struct with contents as specified by $assocArrayVal. See the fourth constructor form for more information.
Returns a string containing "struct", "array" or "scalar" describing the base type of the value. If it returns "undef" it means that the value hasn't been initialised.
If $val->kindOf() == "scalar"(), this method returns the actual PHP-language value of the scalar (base 64 decoding is automatically handled here).
If $val->kindOf() == "scalar"(), this method returns a string denoting the type of the scalar. As mentioned before, i4 is always coerced to int.
Returns the $nth element in the array represented by the value $val. The value returned is an XML_RPC_Value object.
Returns the element called $memberName from the struct represented by the value $val. The value returned is an XML_RPC_Value object.
Returns the next (key,value) pair from the struct, when $val is a struct. See also structreset().
The current implementation of this class has been kept as simple as possible. The constructor for the server basically does all the work. Here's a minimal example:
function foo ($params) { ... } $s = new XML_RPC_Server(array("examples.myFunc" => array("function" => "foo"))); |
This performs everything you need to do with a server. The single argument is an associative array from method names to function names. The request is parsed and despatched to the relevant function, which is reponsible for returning a XML_RPC_Response object, which gets serialized back to the caller.
Here is a more detailed look at what the handler function foo() may do:
function foo ($params) { global $XML_RPC_erruser; // import user errcode value // $params is the received XML_RPC_Message object. if ($err) { // this is an error condition return new XML_RPC_Response(0, $xmlrpcerruser+1, // user error 1 "There's a problem, Captain"); } else { // this is a successful value being returned return new XML_RPC_Response(new XML_RPC_Value("All's fine!", "string")); } } |
The first argument to the XML_RPC_Server() constructor is an array, called the dispatch map. In this array is the information the server needs to service the XML-RPC methods you define.
The dispatch map takes the form of an associative array of associative arrays: the outer array has one entry for each method, the key being the method name. The corresponding value is another associative array, which can have the following members:
function() - this entry is mandatory. It must be a name of a function in the global scope which services the XML-RPC method.
signature() - this entry is an array containg the possible signatures (see Signatures) for the method. If this entry is present then the server will check that the correct number and type of parameters have been sent for this method before dispatching it.
docstring() - this entry is a string containing documentation for the method. The documentation may contain HTML markup.
A signature is a description of a method's return type and its parameter types. A method may have more than one signature.
Within a server's dispatch map, each method has an array of possible signatures. Each signature is an array of types. The first entry is the return type. For instance, the method
string examples.getStateName(int) |
array($xmlrpcString, $xmlrpcInt) |
$findstate_sig = array(array($xmlrpcString, $xmlrpcInt)); $findstate_doc='When passed an integer between 1 and 51 returns the name of a US state, where the integer is the index of that state name in an alphabetic order.'; $s = new XML_RPC_Server(array("examples.getStateName" => array("function" => "findstate", "signature" => $findstate_sig, "docstring" => $findstate_doc))); |
For convenience the strings representing the XML-RPC types have been encoded as global variables:
$xmlrpcI4 = "i4"; $xmlrpcInt = "int"; $xmlrpcBoolean = "boolean"; $xmlrpcDouble = "double"; $xmlrpcString = "string"; $xmlrpcDateTime = "dateTime.iso8601"; $xmlrpcBase64 = "base64"; $xmlrpcArray = "array"; $xmlrpcStruct = "struct"; |
You may want to construct the server, but for some reason not fulfill the request immediately (security verification, for instance). If you pass the constructor a second argument of 0 this will have the desired effect. You can then use the service()() method of the server class to service the request. For example:
$s = new XML_RPC_Server($myDispMap, 0); // ... some code that does other stuff here $s->service(); |
Fault codes for your servers should start at the value indicated by the global $xmlrpcerruser + 1.
Standard errors returned by the server include:
Returned if the server was asked to dispatch a method it didn't know about
This error is actually generated by the client, not server, code, but signifies that a server returned something it couldn't understand.
This error is generated when the server has signature(s) defined for a method, and the parameters passed by the client do not match any of signatures.
This error is generated by the builtin system.*() methods when any kind of introspection is attempted on a method undefined by the server.
This error is generated by the client when a remote server doesn't return HTTP/1.1 200 OK in response to a request. A more detailed error report is added onto the end of the phrase above.
Returns 100 plus the XML parser error code for the fault that occurred. The faultString() returned explains where the parse error was in the incoming XML stream.