Raccourcis : Contenu - rubriques - sous rubriques
EN FR
Jelix 1.7.0-rc.4

Section: XML-RPC

« JSON-RPC ^ Services web SOAP »
Changer de langue : EN

Jelix propose la prise en charge de xml-rpc. C'est un protocole d'échange de données en XML : un client envoie un contenu XML indiquant une fonction à exécuter et des paramètres. Le serveur renvoie un résultat, toujours sous forme de XML (RPC = Remote Procedure Call).

Point d'entrée spécifique

Une requête XML-RPC est spécifique, et pour y répondre, on ne peut pas utiliser l'objet request "classic". Il vous faut créer un point d'entrée spécifique dans le répertoire www, xmlrpc.php par exemple, qui utilise jXmlRpcRequest plutôt que jClassicRequest. Le type de requête et du point d'entrée est donc "xmlrpc".

Utilisez la commande app:create-entrypoint, en indiquant le type xmlrpc:


php dev.php app:create-entrypoint --type=xmlrpc xmlrpc.php

Cela créera un point d'entrée xmlrpc.php dans www/, et le déclarera dans urls.xml et framework.ini.php.

Vous pouvez alors récupérer l'url d'une action pour xmlrpc comme ceci :


  $url = jUrl::get("module~action@xmlrpc");

Contrôleur

Comme on a affaire à un type de requête particulier, le nom du fichier du contrôleur doit avoir le suffixe ".xmlrpc.php". Par exemple, un contrôleur "default" : "default.xmlrpc.php". (Vous pouvez bien sûr avoir un autre contrôleur "default" pour d'autres types de requêtes, "default.classic.php" par exemple).

Ensuite, le contenu du contrôleur est similaire à ce que vous avez l'habitude de faire, à la seule différence que vous utiliserez jResponseXmlRpc, qui a pour alias "xmlrpc", pour répondre aux requêtes XMLRpc :


class defaultCtrl extends jController {

  function index(){

    $rep = $this->getResponse('xmlrpc');

    // n'importe quelles types de données : entier, chaine, array, objets...
    $donnees_php = ... ;

    $rep->response = $donnees_php;

    return $rep;

  }
}

Appel depuis le client

Qui dit XmlRpc, dit une partie cliente qui envoi une requête xmlrpc. Comme vous pouvez le lire dans la spécification de xml-rpc, il faut envoyer du contenu XML de ce type :


<?xml version="1.0" ?>
<methodCall>
   <methodName>module:default:index</methodName>
  <params>
     <param><string>Allo ?</string></param>
  </params>
</methodCall>

Dans <methodName>, vous indiquerez, dans le cas d'un appel à une application jelix, le sélecteur de l'action à appeler, comme ici module:default:index.

Notez qu'il faut indiquer le caractère ":" plutôt que "~" comme séparateur du nom du module et du nom de l'action. En effet, le caractère tilde "~" est interdit dans le nom de la méthode en xmlrpc. De ce fait, il faut obligatoirement indiquer le module, le controleur et la méthode.

Les données que vous mettrez dans params seront mises dans le paramètre params dans la réponse jelix. Ainsi, pour les récupérer dans l'action, vous ferez :


  $parametres = $this->param('params');

Bien entendu, ce que vous avez dans $parametres sera des données "php" (chaine, array ou autre), la transformation du contenu de la balise <params> étant réalisée par jXmlRpcRequest..