Previous Next

WSDL

Note:

La classe Zend_Soap_Wsdl est utilisée par le composant Zend_Soap_Server pour manipuler des documents WSDL. Néanmoins, vous pouvez vous-même utiliser les services fournis par cette classe pour vos propres besoins.

Si vous ne voulez pas l'utiliser pour vos propres besoins, vous pouvez alors passer cette section de la documentation.

Constructeur Zend_Soap_Wsdl

Le constructeur de Zend_Soap_Wsdl prend 3 paramètres:

  1. $name - nom du service Web décrit.
  2. $uri - URI d'accès au fichier WSDL. (Une référence dans le système de fichier local est possible.)
  3. $strategy - identifiant optionnel pour identifier la détection de stratégie des types complexes. Ceci est un booléen $extractComplexTypes avant la version 1.7 et peut toujours être paramétrer via un booléen pour la compatibilité ascendante. Par défaut le comportement de détection de la 1.6 est activé. Pour avoir de plus amples informations concernant les stratégies de détection des types complexes, lisez : Ajouter des infos sur les types complexes..

addMessage()

addMessage($name, $parts) ajoute un message de description au document WSDL (/definitions/message de l'élément).

Chaque message correspond à une méthode en terme de fonctionnalité de Zend_Soap_Server et Zend_Soap_Client.

Le paramètre $name représente le nom du message.

Le paramètre $parts est un tableau de paramètre des messages décrivant les paramètres d'appel SOAP. Le tableau est associatif: 'nom du paramètre' (nom du paramètre d'appel SOAP) => 'type du paramètre'.

La correspondance de types est effectuée grâce à addTypes() et addComplexType()(voyez après).

Note:

Les paramètres de messages peuvent être soit "element", soit "type" (voyez http://www.w3.org/TR/wsdl#_messages).

"element" doit correspondre à un élément de définition de type. "type" correspond à une entrée complexType.

Tous les types standards XSD possèdent une définition "element" et "complexType" (Voyez http://schemas.xmlsoap.org/soap/encoding/).

Tous les éléments non standards, qui doivent être ajoutés avec la méthode Zend_Soap_Wsdl::addComplexType(), sont décrits en utilisant un noeud "complexType" décrits dans la section "/definitions/types/schema/" du document WSDL.

Ainsi, la méthode addMessage() utilise toujours un attribut "type" pour décrire des types.

addPortType()

addPortType($name) ajoute un nouveau type de portage au document WSDL (/definitions/portType).

Ceci fait la jointure entre des méthodes du service décrites en tant qu'implémentations de Zend_Soap_Server.

Voyez http://www.w3.org/TR/wsdl#_porttypes pour plus de détails.

addPortOperation()

addPortOperation($portType, $name, $input = false, $output = false, $fault = false) ajoute des définitions de portage au portage défini dans le document WSDL (/definitions/portType/operation).

Chaque opération de portage correspond à une méthode de classe (si le Web Service est basé sur une classe) ou à une fonction (si le Web Service est basé sur des fonctions), ceci en terme d'implémentation de Zend_Soap_Server.

Cette méthode ajoute aussi les messages d'opération correspondants aux portages, ceci dépend des paramètres $input, $output and $fault.

Note:

Zend_Soap_Server génère 2 messages pour chaque opération de portage lorsque le service est décrit au travers de la classe Zend_Soap_Server:

  • Le message d'entrée nommé $methodName . 'Request'.

  • Les message de sortie nommé $methodName . 'Response'.

Voyez http://www.w3.org/TR/wsdl#_request-response pour les détails.

addBinding()

addBinding($name, $portType) ajoute de nouvelles correspondances (bindings) au document WSDL (/definitions/binding).

Le noeud du document WSDL "binding" définit le format du message et les détails du protocole pour les opérations et messages définis par un portage "portType" particulier (voyez http://www.w3.org/TR/wsdl#_bindings).

La méthode crée le noeud de correspondance et le retourne. Il peut alors être utilisé.

L'implémentation de Zend_Soap_Server utilise le nom $serviceName . "Binding" pour la correspondance ("binding") de l'élément du document WSDL.

addBindingOperation()

addBindingOperation($binding, $name, $input = false, $output = false, $fault = false) ajoute une opération à l'élément de correspondance avec le nom spécifié (/definitions/binding/operation).

Cette méthode prend un objet XML_Tree_Node tel que retourné par addBinding(), en paramètre ($binding) pour ajouter un élément "operation" avec des entrées input/output/false dépendantes des paramètres spécifiés.

Zend_Soap_Server ajoute les correspondances pour chaque méthode du Web Service avec des entrées et sorties, définissant l'élément "soap:body" comme <soap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>

Voyez les détails à http://www.w3.org/TR/wsdl#_bindings.

addSoapBinding()

addSoapBinding($binding, $style = 'document', $transport = 'http://schemas.xmlsoap.org/soap/http') ajoute des correspondances (bindings) SOAP ("soap:binding") à l'élément (déjà lié à un portage de type) avec le style et le transport spécifié (Zend_Soap_Server utilise le style RPC sur HTTP).

L'élément "/definitions/binding/soap:binding" est alors utilisé pour spécifier que la correspondance est relative au format du protocole SOAP.

Voyez http://www.w3.org/TR/wsdl#_bindings pour les détails.

addSoapOperation()

addSoapOperation($binding, $soap_action) ajoute une opération SOAP ("soap:operation") à l'élément de correspondance avec l'action spécifiée. L'attribut "style" de l'élément "soap:operation" n'est pas utilisé alors que le modèle de programmation (RPC-oriented ou document-oriented) devrait utiliser la méthode addSoapBinding()

L'attribut "soapAction" de l'élément "/definitions/binding/soap:operation" spécifie la valeur de l'en-tête SOAPAction pour l'opération. Cet attribut est requis pour SOAP sur HTTP et ne doit pas être renseigné pour les autres modes de transports.

Zend_Soap_Server utilise $serviceUri . '#' . $methodName pour le nom de l'action SOAP.

Voyez http://www.w3.org/TR/wsdl#_soap:operation pour plus de détails.

addService()

addService($name, $port_name, $binding, $location) ajoute un élément "/definitions/service" au document WSDL avec le nom du Web Service spécifié, le nom du portage, la correspondance, et l'adresse.

WSDL 1.1 autorise d'avoir plusieurs types de portage par service. Cette particularité n'est pas utilisée dans Zend_Soap_Server et est non supportée par la classe Zend_Soap_Wsdl.

Utilisations de Zend_Soap_Server :

  • $name . 'Service' comme nom du Web Service,

  • $name . 'Port' comme nom de portage des types,

  • 'tns:' . $name . 'Binding' [1] 'tns:' namespace'http://' .$_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'] comme nom de la correspondance,

  • l'URI du script[2] 'http://' .$_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'] en tant qu'URI du service pour les Web Service utilisant des classes.

$name est un nom de classe pour le Web Service utilisant des classes, ou un nom de script pour le Web Service qui utilise des fonctions.

Voyez http://www.w3.org/TR/wsdl#_services pour les détails.

Correspondance de type.

Le WSDL de Zend_Soap utilise les correspondances suivantes pour faire correspondre les type SOAP à des types PHP:

  • chaînes PHP <-> xsd:string.

  • entiers PHP <-> xsd:int.

  • flottants PHP <-> xsd:float.

  • booléens PHP <-> xsd:boolean.

  • tableaux PHP <-> soap-enc:Array.

  • objets PHP <-> xsd:struct.

  • Classe PHP <-> basé sur la stratégie des types complexes (Voir : Ajouter des infos sur les types complexes.)[3] Zend_Soap_AutoDiscoverZend_Soap_Wsdl_Strategy_DefaultComplexTypeZend_Soap_Wsdl_Strategy_Interface$extractComplexTypeZend_Soap_Wsdl sur l'ajout des types complexes .

  • Type PHP vide <-> void.

  • Si le type na aucune correspondance avec les valeurs ci-dessus, alors xsd:anyType est utilisé.

xsd: est l'espace de noms "http://www.w3.org/2001/XMLSchema", soap-enc: est l'espace de noms "http://schemas.xmlsoap.org/soap/encoding/", tns: est un "espace de noms cible" pour le service.

Récupérer des infos sur les types.

getType($type) peut être utilisée pour récupérer la correspondance d'un type PHP spécifié :

...
$wsdl = new Zend_Soap_Wsdl('My_Web_Service', $myWebServiceUri);

...
$soapIntType = $wsdl->getType('int');

...
class MyClass {
    ...
}
...
$soapMyClassType = $wsdl->getType('MyClass');

Ajouter des infos sur les types complexes.

addComplexType($type) est utilisée pour ajouter des types complexes (classes PHP) à un document WSDL.

C'est automatiquement utilisé par la méthode getType() pour ajouter les types complexes des paramètres de méthodes ou des types retournés.

Sa détection et son algorithme de construction est basé sur la détection de stratégie des types complexes couramment active. Vous pouvez paramétrer la stratégie de détection soit en spécifiant le nom de classe sous la forme d'une chaîne de caractères ou une instance implémentant Zend_Soap_Wsdl_Strategy_Interface en tant que troisième paramètre du constructeur ou en utilisant la fonction setComplexTypeStrategy($strategy) de Zend_Soap_Wsdl. Les stratégies de détection suivantes existent couramment :

  • la classe Zend_Soap_Wsdl_Strategy_DefaultComplexType : activé par défaut (quand aucun troisième paramètre n'est fourni). Itère parmi les attributs publics d'un type de classe et les enregistre en tant que sous-types d'un type d'objet complexe.

  • la classe Zend_Soap_Wsdl_Strategy_AnyType : caste tous les types complexes en un type XSD simple xsd:anyType. Attention ce raccourci pour la détection des types complexes peut probablement seulement être géré avec des langages faiblement typés comme le PHP.

  • la classe Zend_Soap_Wsdl_Strategy_ArrayOfTypeSequence : cette stratégie permet de spécifier les paramètres de retour de type : int[] ou string[]. Il peut seulement gérer les types PHP simples comme int, string, boolean, float et ainsi de suite, mais permet de spécifier des tableaux imbriqués de tableaux de type.

  • la classe Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex : cette stratégie permet de détecter des tableaux complexes d'objets. Les types d'objets sont détectés sur la base de Zend_Soap_Wsdl_Strategy_DefaultComplexType et un tableau enveloppe cette définition.

la méthode addComplexType() crée un élément "/definitions/types/xsd:schema/xsd:complexType" pour chaque type complexe décrit avec le nom d'une classe PHP spécifiée.

Les propriétés des classes doivent posséder un bloc de documentation avec le type PHP en question, afin que la propriété soit incluse dans la description WSDL.

addComplexType() vérifie sur le type est déjà décrit dans la section des types du document WSDL.

Ceci évite les duplications et récursions si cette méthode est appelée plus d'une fois.

Voyez http://www.w3.org/TR/wsdl#_types pour plus de détails.

addDocumentation()

addDocumentation($input_node, $documentation) ajoute de la documentation lisible ("human readable") grâce à l'élément optionnel "wsdl:document".

L'élément "/definitions/binding/soap:binding" est utilisé pour dire que la correspondance est liée au format du protocole SOAP.

Voyez http://www.w3.org/TR/wsdl#_documentation pour les détails.

Récupérer un document WSDL finalisé.

toXML(), toDomDocument() et dump($filename = false) peuvent être utilisées pour récupérer un document WSDL sous forme de XML, de structure DOM, ou de fichier.

[1] est l'URI du script ().
[3] sera créé avec la classe en tant qu'algorithme de détection pour les types complexes. Le premier paramètre du constructeur AutoDiscover accepte toute stratégie de types complexes implémentant ou une chaîne correspondant au nom de la classe. Pour une compatibilité ascendante, avec les variables booléennes sont analysées comme avec Zend_Soap_Wsdl. Regardez le manuel pour plus d'informations.
Previous Next
Introduction to Zend Framework
Présentation
Installation
Zend_Acl
Introduction
Affiner les Contrôles d'Accès
Utilisation avancée
Zend_Amf
Introduction
Zend_Amf_Server
Zend_Auth
Introduction
Authentification avec une table de base de données
Authentification "Digest"
Adaptateur d'authentification HTTP
LDAP Authentication
Authentification OpenID
Zend_Cache
Introduction
Aspect théorique
Les frontends Zend_Cache
Les backends Zend_Cache
Zend_Captcha
Introduction
Opération Captcha
Adaptateurs Captcha
Zend_Config
Introduction
Aspect théorique
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction à Getopt
Déclarer les règles Getopt
Extraire les options et les arguments
Configurer Zend_Console_Getopt
Zend_Controller
Zend_Controller - Démarrage rapide
Fondations de Zend_Controller
Le contrôleur frontal (Front Controller)
L'objet Requête
Routeur Standard
Le dispatcheur
Contrôleurs d'action
Aides d'action (Helper)
Objet de réponse
Plugins
Utilisation de conventions de dossiers modulaires
Exceptions avec MVC
Migrer depuis des versions précédentes
Zend_Currency
Introduction à Zend_Currency
How to work with currencies
Migrer depuis des versions antérieures
Zend_Date
Introduction
Aspect théorique
Méthodes de base
Zend_Date API Overview
Créer des dates
Constants for General Date Functions
Exemples concrets
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Relations Zend_Db_Table
Zend_Debug
Afficher des informations
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Les aides de vues Dojo
Les éléments de formulaire et les décorateurs Dojo
Zend_Dom
Introduction
Zend_Dom_Query
Zend_Exception
Utiliser les exceptions
Zend_Feed
Introduction
Importer des flux
Obtenir des flux à partir de pages Web
Consommer un flux RSS
Consommer un flux Atom
Consommer une entrée Atom particulière
Modifier la structure du flux ou des entrées
Classes personnalisées pour les flux et entrées
Zend_File
Zend_File_Transfer
Validateurs pour Zend_File_Transfer
Filtres pour Zend_File_Transfer
Migrer à partir des versions précédentes
Zend_Filter
Introduction
Classes de filtre standards
Chaînes de filtrage
Écriture de filtres
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form Quick Start
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Creating Custom Form Markup Using Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Standard Form Decorators Shipped With Zend Framework
Internationalization of Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction to Gdata
Authentification par procédé AuthSub
Using the Book Search Data API
Authentification avec ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Health
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Utilisation des albums Web Picasa
Using the YouTube Data API
Attraper les exceptions Gdata
Zend_Http
Zend_Http_Client - Introduction
Zend_Http_Client - Utilisation avancée
Zend_Http_Client - Adaptateurs de connexion
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introduction
Utilisation de base
Objets JSON
XML to JSON conversion
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introduction
Zend_Layout - Démarrage rapide
Zend_Layout options de configuration
Zend_Layout, utilisation avancée
Zend_Ldap
Introduction
Zend_Loader
Charger les fichiers et les classes dynamiquement
Chargeur de Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported locales
Migrer à partir des versions précédentes
Zend_Log
Présentation
Rédacteurs (Writers)
Formateurs (mise en forme)
Filtres
Zend_Mail
Introduction
Envoyer des émail en utilisant SMTP
Envoyer plusieurs émail par connexion SMTP
Utiliser différents transports
Émail HTML
Fichiers joints
Ajouter des destinataires
Contrôler les limites MIME
Entêtes additionnelles
Jeux de caractères
Encodage
Authentification SMTP
Sécuriser les transports SMTP
Lire des émail
Zend_Measure
Introduction
Création d'une mesure
Récupérer des mesures
Manipuler des mesures
Types de mesures
Zend_Memory
Présentation
Manager de mémoire
Objet mémoire
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introduction
Utilisation
Configuration
Utilisation avancée
Zend_Pdf
Introduction.
Créer et charger des documents PDF
Sauvegarder les changement dans un document PDF
Les pages d'un document
Dessiner
Informations du document et métadonnées.
Exemple d'utilisation du module Zend_Pdf
Zend_ProgressBar
Zend_ProgressBar
Zend_Registry
Utiliser le registre
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Overview
Building Indexes
Searching an Index
Query Language
Query Construction API
Jeu de caractères
Extensibility
Agir avec Lucene Java
Avancé
Best Practices
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Introduction
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Introduction
Usage basique
Utilisation avancée
Gestion générale de la session
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL
Auto découverte
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Translate
Introduction
Adaptateurs pour Zend_Translate
Utiliser les adaptateurs de traduction
Migrer à partir des versions précédentes
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Classes de validation standard
Chaînes de validation
Écrire des validateurs
Zend_Version
Lire la version du Zend Framework
Zend_View
Introduction
Scripts de contrôleur
Scripts de vue
Aides de vue
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Configuration système requise par le Zend Framework
Version de PHP requise
Extensions PHP
Les composants du Zend Framework
Dépendances internes du Zend Framework
Convention de codage PHP du Zend Framework
Vue d'ensemble
Formatage des fichiers PHP
Conventions de nommage
Style de codage
Zend Framework Performance Guide
Introduction
Class Loading
Internationalisation (i18n) and Localisation (l10n)
View Rendering
Informations de copyright