Introduction

Introduction –

Description

XML_RPC2 is a "PHP5 only" implementation of the XMLRPC protocol. This package provides the client and the server side of the protocol. An optimized cache is also available for both parts.

As a client library, XML_RPC2 is capable of creating a proxy class which exposes the methods exported by the server. So it's very easy and natural to call XMLRPC exported methods. Like in Python language, the classic way to use XML_RPC2 client side is :

  • We make a XML_RCP2_Client object with server informations as arguments.

  • In a classic way, we call a method of this object.

  • Then, the method call is XMLRPC encoded, sent to the server, the response is decoded into PHP native types and we get the result of the call (all this logic is made by the library in a completely transparent way).

As a server library, XML_RPC2 is capable of exposing methods from a class or object instance, seamlessly capable of exposing methods from a class or object instance, seamlessly exporting local methods as remotely callable procedures. Method signatures are automatically determined and checked by using the reflection API and PHPDOC comments. An automatic documentation about XMLRPC exported methods is dynamically built and available at the server URL (with a simple HTTP GET).

For both sides, an optimized cache based on Cache_Lite can be set. It can be really usefull especially on public XMLRPC servers.

Requirements

XML_RCP2 need PHP5 and the CURL extension. To avoid in next version, the CURL dependency, we are waiting for a PHP5 E_STRICT PEAR module for HTTP_Request.

If you want to use the integrated cache, you will also need the Cache_Lite PEAR module but it's of course an optional dependency.

XML_RPC2 can use two backends for the XMLRPC encoding/decoding :

  • XMLRPCEXT, which of course need this PHP extension (probably the better choice but it's an additional dependency) ;

  • PHP, which doesn't need the XMLRPCEXT extension at all (this is full PHP but slower).

A first example of the client side use

Let's start with a XMLRPC call to the pear.php.net XMLRPC server :

<?php

require_once 'XML/RPC2/Client.php';

$options = array(
    
'prefix' => 'package.'
);

// We make the XML_RPC2_Client object (as the backend is not specified, XMLRPCEXT
// will be used if available (full PHP else))
$client XML_RPC2_Client::create('http://pear.php.net/xmlrpc.php'$options);

try {

    
// Because of the prefix specified in the $options array, indeed,  we will call
    // the package.info() method with a single argument (the string 'XML_RPC2')
    
$result $client->info('XML_RPC2');

    
// $result is a complex PHP type (no XMLRPC decoding needed, it's already done)
    
print_r($result);

} catch (
XML_RPC2_FaultException $e) {

    
// The XMLRPC server returns a XMLRPC error
    
die('Exception #' $e->getFaultCode() . ' : ' $e->getFaultString());

} catch (
Exception $e) {

    
// Other errors (HTTP or networking problems...)
    
die('Exception : ' $e->getMessage());

}

?>

A first example of the server side use

Let's build a XMLRPC "echo server" :

<?php

require_once 'XML/RPC2/Server.php';

// Let's define a class with public static methods
// PHPDOC comments are really important because they are used for automatic
// signature checking

class EchoServer {

    
/**
     * echoes the message received
     *
     * @param string  Message
     * @return string The echo
     */
    
public static function echoecho($string) {
        return 
$string;
    }

}

$options = array(
    
'prefix' => 'test.' // we define a sort of "namespace" for the server
);

// Let's build the server object with the name of the Echo class 
$server XML_RPC2_Server::create('EchoServer'$options);
$server->handleCall();

?>

If you do a simple HTTP GET on the server URL, you will get an automatic HTML documentation about the echoecho function. If you make a XMLRPC client request on the same URL about the "test.echoecho()" method (with one argument), you will get your argument as a response. If you call another method or with a bad arguments number, you will get an error (because of automatic method signature checking).

A first example of the client side use (with integrated cache)

As the caching process is completely transparent, this is very similar to the standard client side use :

<?php

require_once 'XML/RPC2/CachedClient.php';

$options = array(
    
'prefix' => 'package.',
    
'cacheDebug' => false// with cacheDebug set to true, it's very easy
                           // to get an indication about the cache using (or not)
    
'cacheOptions' => array(
        
'cacheDir' => '/tmp/',
        
'lifetime' => 3600,      // during this lifetime, the local cache will be used 
        
'cacheByDefault' => true // all methods call will be cached
                                 // (but a more precise way is possible)
    
)
);

// We make the XML_RPC2_CachedClient object (same syntax than XML_RPC2_Client)
$client XML_RPC2_CachedClient::create('http://pear.php.net/xmlrpc.php'$options);

try {

    
// First call, the cache won't be used
    
$result $client->info('XML_RPC2');
    
print_r($result);

    
// Second call, the cache will be used  (in a transparent way) and no
    // additional HTTP request will be sent to the server
    
$result $client->info('XML_RPC2');
    
print_r($result);

} catch (
XML_RPC2_FaultException $e) {

    
// The XMLRPC server returns a XMLRPC error
    
die('Exception #' $e->getFaultCode() . ' : ' $e->getFaultString());

} catch (
Exception $e) {

    
// Other errors (HTTP or networking problems...)
    
die('Exception : ' $e->getMessage());

}

?>

A first example of the server side use (with integrated cache)

As the caching process is completely transparent, this is very similar to the standard server side use :

<?php

require_once 'XML/RPC2/CachedServer.php';

// Let's define a class with public static methods
// PHPDOC comments are really important because they are used for automatic
// signature checking

// IMPORTANT : note the @xmlrpc.caching PHPDOC tags to indicate
// that the method has to be cached

class EchoServer {

    
/**
     * echoes the message received
     *
     * @param string  Message
     * @return string The echo
     * @xmlrpc.caching true
     */
    
public static function echoecho($string) {
        return 
$string;
    }

}

$options = array(
    
'prefix' => 'test..',
    
'cacheDebug' => false// with cacheDebug set to true, it's very easy
                           // to get an indication about the cache using (or not)
    
'cacheOptions' => array(
        
'cacheDir' => '/tmp/',
        
'lifetime' => 3600,
        
'cacheByDefault' => false // we don't cache by default (only methods with @xmlrpc.caching true)
    
)
);

$server XML_RPC2_CachedServer::create('EchoServer'$options);  
$server->handleCall();

?>
XML_RPC2 (Previous) Client Side (Next)
Last updated: Fri, 19 Dec 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: simon nuttall

// The package uses @dl() to load modules that might not exist.
// That function is deprecated in PHP5.3.
// Define it if it doesn't already exist before calling any XMPRPC methods:
if(!function_exists('dl')) {
function dl($ignore) {return false;}
}

// Also the example might be a little clearer if the key bit is structured like this:

$url = 'http://pear.php.net/xmlrpc.php';
$function = 'echoecho';
$arg = 'XML_RPC2';
$client = XML_RPC2_Client::create($url, $options);

try {
$result = $client->{$function}($arg);
}