{"id":313,"date":"2014-02-10T21:34:29","date_gmt":"2014-02-10T20:34:29","guid":{"rendered":"http:\/\/louis.hatier.me\/blog\/?p=313"},"modified":"2021-03-05T22:22:31","modified_gmt":"2021-03-05T21:22:31","slug":"soap-zend-framework","status":"publish","type":"post","link":"https:\/\/louis.hatier.me\/blog\/soap-zend-framework\/","title":{"rendered":"SOAP avec Zend Framework"},"content":{"rendered":"

\"Logo<\/a><\/p>\n

Simple Object Access Protocol (SOAP) est un protocole qui permet d’\u00e9changer des messages \u00e0 distance.<\/p>\n

 <\/p>\n

Ce protocole peut \u00eatre utilis\u00e9 pour cr\u00e9er ou appeler des Web Services<\/a> via HTTP.<\/p>\n

Sa structure est d\u00e9crite au format XML.<\/p>\n

<\/p>\n

Exemple d’utilisation de SOAP avec Zend Framework<\/h2>\n

Voici un exemple simple d’utilisation de SOAP, avec la partie c\u00f4t\u00e9 serveur, et c\u00f4t\u00e9 client.<\/p>\n

 <\/p>\n

C\u00f4t\u00e9 serveur<\/h3>\n

Tout d’abord, installer si ce n’est pas d\u00e9j\u00e0 le cas, le paquet php-soap : apt-get install php-soap<\/code>.<\/p>\n

Ensuite, dans un projet Zend, cr\u00e9er un controller<\/em> SoapController<\/code>, avec une fonction wsdlAction<\/code> qui va g\u00e9n\u00e9rer le fichier WSDL (xml).<\/p>\n

Le fichier WSDL<\/a> sert \u00e0 d\u00e9crire notre service web, on lui pr\u00e9cise donc la classe qu’il devra d\u00e9crire.<\/p>\n

class SoapController extends Zend_Controller_Action\n{\n    public function init()\n    {\n        Zend_Layout::getMvcInstance()->disableLayout();\n        Zend_Controller_Front::getInstance()->setParam('noViewRenderer', true);\n    }\n\n    public function indexAction()\n    {\n        $soapServer = new Zend_Soap_Server(\n            'http:\/\/www.mon-serveur.fr\/soap\/wsdl\/',\n            array(\n                'soap_version' => SOAP_1_1,\n                'encoding'     => 'UTF-8'\n            )\n        );\n        $soapServer->setPersistence(SOAP_PERSISTENCE_SESSION);\n        $soapServer->setClass('Soap_User');\n        $soapServer->handle();\n    }\n\n    public function wsdlAction()\n    {\n        $wsdl = new Zend_Soap_AutoDiscover();\n        $wsdl->setClass('Soap_User');\n        $wsdl->setUri('http:\/\/www.mon-serveur.fr\/soap\/');\n        $wsdl->handle();\n    }\n}\n<\/code><\/pre>\n
Maintenant il faut \u00e9crire notre classe Soap_User<\/code> en pr\u00e9cisant bien les param\u00e8tres en entr\u00e9e et la valeur en sortie.<\/p>\n
class Soap_User\n{\n    \/**\n     * Retourne un utilisateur\n     * \n     * @param integer $idUser\n     * @return array\n     *\/\n    public function getUser($idUser)\n    {\n        $tableUser = new Table_User();\n\n        return $tableUser->fetchRow(\n            $tableUser->select()->where('idUser = ?', $idUser)\n        )->toArray();\n    }\n}\n<\/code><\/pre>\n
 <\/p>\n
C\u00f4t\u00e9 client<\/h3>\n
On commence par pr\u00e9ciser qu’on ne veut pas utiliser le cache WSDL (\u00e0 faire pendant la p\u00e9riode de test).<\/p>\n
ini_set('soap.wsdl_cache_enabled', '0');\n<\/code><\/pre>\n
Ensuite, dans un controller<\/em> quelconque, on va utiliser le service web cr\u00e9er plus haut.<\/p>\n
On cr\u00e9er un objet Zend_Soap_Client<\/code> en lui pr\u00e9cisant l’adresse du fichier WSDL, et un tableau d’options.<\/p>\n
$optionsSoap = array(\n    'soap_version' => SOAP_1_1,\n    'encoding'     => 'UTF-8',\n    'compression'  => SOAP_COMPRESSION_ACCEPT\n);\n$soapClient = new Zend_Soap_Client('http:\/\/www.mon-serveur.fr\/soap\/wsdl\/', $optionsSoap);\n<\/code><\/pre>\n
Maintenant, on peut facilement faire appel \u00e0 la fonction qui permet de r\u00e9cup\u00e9rer un utilisateur :<\/p>\n
try {\n    $user = $soapClient->getUser(3);\n} catch (Soap_Fault $e) {\n    var_dump($e);\n}\n<\/code><\/pre>\n
Si vous ne voulez pas t\u00e9l\u00e9charger le fichier xml \u00e0 chaque appel, vous pouvez r\u00e9activer le cache et \u00e9galement pr\u00e9ciser un dossier et une dur\u00e9e de vie :<\/p>\n
ini_set('soap.wsdl_cache_enabled', '1');\nini_set('soap.wsdl_cache_dir', '\/tmp');\nini_set('soap.wsdl_cache_ttl', 86400);<\/code><\/pre>\n
 <\/p>\n
SoapUI<\/h2>\n
Pour tester votre WS, vous pouvez utiliser SoapUI<\/a>.
\nLe logiciel permet de tester plusieurs services web, il suffit de pr\u00e9ciser l\u2019adresse d’un fichier WSDL, et de rentrer des donn\u00e9es \u00e0 la main (dans notre cas un identifiant utilisateur), le r\u00e9sultat vous sera affich\u00e9.<\/p>\n
\"Share<\/a>