Les fonctionnalités SOAP de Zend Framework sont proposées afin de simplifier l'accès aux services Web de type SOAP.

SOAP est un protocole d'échange de données indépendant d'un langage. Il peut donc être utilisé avec une autre technologie que PHP.

Il y a trois configurations d'utilisation de SOAP avec Zend Framework :

Il est indispensable de connaître les fonctionnalités qu'offre un serveur SOAP, afin de pouvoir communiquer avec lui. WSDL est alors utilisé pour décrire en détail l'API des services disponibles sur un serveur SOAP.

Le langage WSDL est assez complexe (voyez http://www.w3.org/TR/wsdl pour les détails ). Il est donc difficile d'écrire une définition WSDL correcte, à la main.

Un autre problème concerne la synchronisation des changements dans l'API avec des fichiers WSDL déjà existants.

Ces 2 problèmes peuvent être résolus avec la génération automatique de WSDL, qui permet d'analyser une classe ou des fonctions, d'en extraire les paramètres d'entrée/sortie, et de générer un fichier WSDL correct et compréhensible par le serveur et les clients SOAP.

Il y a deux façons d'utiliser Zend Framework pour une application serveur SOAP:

Ces deux façons sont supportées par la fonctionnalité d'auto génération de Zend Framework.

Zend_Soap_AutoDiscovery supporte aussi la correspondance des types PHP vers les types XSD.

Voici un exemple d'utilisation de l'auto découverte. La fonction handle() génère le fichier WSDL et l'envoie au navigateur :

class My_SoapServer_Class {
...
}

$autodiscover = new Zend_Soap_AutoDiscover();
$autodiscover->setClass('My_SoapServer_Class');
$autodiscover->handle();

Si vous avez besoin d'accéder au fichier WSDL généré soit pour le sauvegarder dans un fichier ou en tant que chaîne de caractères, vous pouvez utiliser les méthodes dump($filename) ou toXml() que la classe AutoDiscover fournit.

if(isset($_GET['wsdl'])) {
    $autodiscover = new Zend_Soap_AutoDiscover();
    $autodiscover->setClass('HelloWorldService');
    $autodiscover->handle();
} else {
    // pointing to the current file here
    $soap = new Zend_Soap_Server("http://example.com/soap.php?wsdl");
    $soap->setClass('HelloWorldService');
    $soap->handle();
}

Si une classe est utilisée dans un serveur SOAP, alors celle-ci devrait aussi être fournie à Zend_Soap_AutoDiscovery afin d'en générer le fichier WSDL :

$autodiscover = new Zend_Soap_AutoDiscover();
$autodiscover->setClass('My_SoapServer_Class');
$autodiscover->handle();

Les règles suivantes sont utilisées lors de la génération du fichier WSDL :

Si des fonctions doivent être utilisées (partagées) via un serveur SOAP, alors elles doivent être passées à Zend_Soap_AutoDiscovery pour générer un fichier WSDL :

$autodiscover = new Zend_Soap_AutoDiscover();
$autodiscover->addFunction('function1');
$autodiscover->addFunction('function2');
$autodiscover->addFunction('function3');
...
$autodiscover->handle();

Les règles suivantes sont utilisées lors de la génération du fichier WSDL :

Les types de données d'entrée/sortie sont convertis en types spéciaux pour le réseau, suivant ces règles :

Où xsd: est l'espace "http://www.w3.org/2001/XMLSchema", soap-enc: est l'espace "http://schemas.xmlsoap.org/soap/encoding/", tns: est "l'espace de nom cible" du service.

WSDL offre différents mécanismes et styles de transport. Ceci affecte les balises soap:binding et soap:body à l'intérieur de la section binding du WSDL. Différents clients ont différentes conditions quant aux options qui sont vraiment utilisées. Par conséquent vous pouvez placer les styles avant d'appeler n'importe quelle méthode setClass ou addFunction de la classe AutoDiscover.

$autodiscover = new Zend_Soap_AutoDiscover();
// Par défaut il s'agit de 'use' => 'encoded'
// et 'encodingStyle' => 'http://schemas.xmlsoap.org/soap/encoding/'
$autodiscover->setOperationBodyStyle(array('use' => 'literal', 'namespace' => 'http://framework.zend.com'));

// Par défaut il s'agit de 'style' => 'rpc'
// et 'transport' => 'http://schemas.xmlsoap.org/soap/http'
$autodiscover->setBindingStyle(array('style' => 'document', 'transport' => 'http://framework.zend.com'));
...
$autodiscover->addFunction('myfunc1');
$autodiscover->handle();