Zend Framework possède la capacité de consommer des services distants XML-RPC, via la classe Zend_XmlRpc_Client. Ses caractéristiques principales sont la conversion automatique des types entre PHP et XML-RPC, un objet proxy de serveur, et des possibilités d'introspection du serveur.

Le constructeur de Zend_XmlRpc_Client reçoit en premier paramètre l'URL du serveur XML-RPC distant. L'instance retournée pourra alors être utilisée pour appeler n'importe quelle méthode distante.

Pour appeler une méthode distante, utilisez la méthode call() de votre instance. Le code suivant montre un exemple avec le serveur XML-RPC du site de Zend Framework. Vous pouvez l'utiliser pour tester ou explorer les possibilités des composants Zend_XmlRpc.

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

echo $client->call('test.sayHello');

// hello

Le type de la valeur XML-RPC retournée sera automatiquement casté en un type compatible PHP. Dans l'exemple ci-dessus, une string PHP est retournée et immédiatement utilisable.

Le premier paramètre de call() est le nom de la méthode distante à appeler. Si celle-ci demande des paramètres, ceux-ci doivent alors être passés via le deuxième paramètre de call(), sous forme de tableau PHP (array) :

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$arg1 = 1.1;
$arg2 = 'foo';

$result = $client->call('test.sayHello', array($arg1, $arg2));

// $result est un type PHP natif

Le tableau de paramètres peut contenir des types PHP natifs, des objets Zend_XmlRpc_Value, ou bien les deux à la fois.

La méthode call() convertira automatiquement la réponse XML-RPC et retournera un type PHP natif valide. Un objet Zend_XmlRpc_Response pour la valeur de retour sera de même disponible, via un appel à getLastResponse().

Certaines méthodes distantes requièrent des paramètres. Ceux-ci sont donnés sous forme de tableau PHP à call(). Chaque paramètre est supposé être un type PHP natif qui sera alors lui-même converti, ou alors un objet représentant un type XML-RPC (un objet parmi les Zend_XmlRpc_Value).

$client->setSkipSystemLookup(true);
$result = $client->call('foo.bar', array(array()));

Un autre moyen d'appeler des méthodes avec un client XML-RPC est d'utiliser le proxy du serveur. C'est un objet PHP qui proxie un espace de nom XML-RPC, en fonctionnant autant que possible comme les objets PHP.

Pour instancier un proxy serveur, appelez getProxy() de Zend_XmlRpc_Client. Elle retourne un objet Zend_XmlRpc_Client_ServerProxy. Tout appel de méthode sur l'objet proxy sera proxié vers le serveur XML-RPC, et les paramètres seront utilisés comme pour une méthode PHP banale.

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$service = $client->getProxy();
// Proxy l'espace de nom par défaut

$hello = $service->test->sayHello(1, 2);
// test.Hello(1, 2) retourne "hello"

La méthode getProxy() reçoit un argument optionnel désignant l'espace de nom à utiliser par le proxy. Par défaut, il s'agit de l'espace général, voici un exemple utilisant un espace de nom test :

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$test  = $client->getProxy('test');
// Proxy l'espace de nommage "test"

$hello = $test->sayHello(1, 2);
// test.Hello(1,2) retourne "hello"

Si le serveur distant supporte les espaces de noms imbriqués, alors le proxy les supportera. Par exemple, si le serveur dans l'exemple ci-dessus acceptait les espaces de noms imbriqués, alors sa méthode test.foo.bar() aurait pu être appelée via $test->foo->bar().

Deux types d'erreurs peuvent être distingués : erreurs HTTP, ou erreurs XML-RPC. L'objet Zend_XmlRpc_Client reconnaît ces erreurs et fournit les moyens de les repérer et de les gérer.

$client = new Zend_XmlRpc_Client('http://foo/404');

try {

    $client->call('bar', array($arg1, $arg2));

} catch (Zend_XmlRpc_Client_HttpException $e) {

    // $e->getCode() retourne 404
    // $e->getMessage() retourne "Not Found"

}

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

try {

    $client->call('badMethod');

} catch (Zend_XmlRpc_Client_FaultException $e) {

    // $e->getCode() retourne 1
    // $e->getMessage() retourne "Unknown method"

}

Certains serveurs XML-RPC supportent l'introspection de leurs méthodes au travers de l'espace de noms system. Zend_XmlRpc_Client fournit un support d'un tel procédé.

Une instance de Zend_XmlRpc_Client_ServerIntrospection sera retournée si vous appelez la méthode getIntrospector() sur l'objet Zend_XmlRpcClient.

Dans les faits, la méthode call() de Zend_XmlRpc_Client fabrique un objet Zend_XmlRpc_Request et l'envoie à une méthode doRequest(), qui retourne un objet de réponse Zend_XmlRpc_Response.

La méthode doRequest() est disponible directement si besoin :

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$request = new Zend_XmlRpc_Request();
$request->setMethod('test.sayHello');
$request->setParams(array('foo', 'bar'));

$client->doRequest($request);

// $client->getLastRequest() retoure instanceof Zend_XmlRpc_Request
// $client->getLastResponse() retourne instanceof Zend_XmlRpc_Response

Lorsqu'une méthode XML-RPC est appelée, quel qu'en soit le moyen, (call(), doRequest() ou proxy serveur), le dernier objet de requête, et son homologue de réponse, seront toujours disponibles, au travers des appels à getLastRequest() et getLastResponse().

Dans tous les exemples utilisés sur cette page, nous ne parlons jamais du client HTTP. Lorsque c'est nécessaire, une instance de Zend_Http_Client sera créée par défaut et injectée dans Zend_XmlRpc_Client de manière automatique.

L'objet client HTTP peut être récupéré à tout moment grâce à la méthode getHttpClient(). setHttpClient() permet d'injecter un objet Zend_Http_Client.

setHttpClient() est particulièrement utilisée pour les tests unitaires. Lorsque combinée avec Zend_Http_Client_Adapter_Test, les services Web peuvent être déguisés (émulés) pour les tests. Voyez les tests unitaires de Zend_XmlRpc_Client pour des exemples concrets.