Introduction
Cette page est destiné à décrire en détail le module WSServer qui a pour but de vous fournir une interface pour exporter n'importe quelle classes de vos modules en Web Services.
Note : Si vous n'êtes pas familier avec SOAP où que vous avez quelques questions concernant l'implémentation de Web Services en PHP, nous vous invitons à consulter la page concernant les Webservices et PHP
L'extension SOAP ne permettant pas de générer automatiquement les fichiers WDSL, le module intègre la classe WSDL_Gen.php pour ce faire. Celle-ci se base sur les commentaires pour identifier les types des paramètres et des retour des fonctions. Veillez donc à bien commencer vos fonction de la manièdre suivante :
/**
* @param int $pParamInt
* @param int $pParamInt
* @return string
*/
function ExempleParams ($pParamInt, $pParamString) {
/**
* Code
*/
return "OK";
}
Installation du module
Condition préalable : votre serveur doit disposer de l'extension SOAP de PHP5. L'installation est classique. Le module installe une table wsservices qui contient les infos sur les services exportés.
Architecture
Le module se trouve dans project/modules/public/stable/tools/wsserver/
Paramètres du module
- exportedModule : Nom du module Copix contenant la classe à exporter par défaut
- exportedClassFile : Nom du fichier contenant la classe à exporter par défaut
- exportedClass : Nom de la classe à exporter par défaut.
Administration
Il est possible de configurer le module de deux manières complémentaires
La première consiste à modifier les paramètres du module pour exporter une classe. Dans ce cas le fichier wsdl est disponible à l'adresse suivante : http://www.votresite.com/index.php/wsserver/default/wsdl/
L'adresse du serveur SOAP est : http://www.votresite.com/index.php/wsserver/
Cette première méthode vous permettra facilement d'exporter une classe. Elle est recommandé dans le cas d'un web service ponctuel.
La deuxième, plus élaborée, va vous permettre d'exporter les classes de vos modules. Pour celà rendez-vous sur l'interface d'administration et cliquez sur "Gestion des exportations WS". Vous obtenez alors la liste complète des Modules installés sur votre serveur et les classes leur appartenant.
Cliquez ensuite sur la classe que vous compter exporter. Par exemple : la classe sample.services.class.php du module "Mise en place d'un serveur SOAP".
Vous obtenez alors un formulaire prérémpli, contenant les informations sur la classe que vous voulez exporter. Indiquez alors le nom que vous voulez donner à votre service.
Exemple : SampleWebService. Cliquez sur valider. Votre web service est créé et vous obtenez les infos récapitulatives sur votre Web Services, à savoir l'URL du Web Services et l'URL du fichier WSDL. Exemple
Url du Webservice : http://localhost/alptis/www/index.php/wsserver/default/default/SampleWebService
Url du fichier wsdl : http://localhost/alptis/www/index.php/wsserver/default/wsdl/SampleWebService
A partir de ces informations vous pourrez créer votre Client SOAP.