Previous Next

Auto découverte

Introduction à l'auto découverte

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 :

  1. SOAP serveur application PHP <---> SOAP client application PHP
  2. SOAP serveur application non PHP <---> SOAP client application PHP
  3. SOAP serveur application PHP <---> SOAP client application non PHP

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:

  • Utiliser des classes.

  • Utiliser des fonctions.

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.

Note: Zend_Soap_Autodiscover n'est pas un serveur SOAP

Il est très important de noter, que la classe Zend_Soap_Autodiscover n'agit pas en tant que serveur SOAP elle-même. Elle génère seulement le WSDL et le fournit à ceux qui accèdent à l'URL qu'elle écoute.

Par défaut l'URI de SOAP est 'http://' .$_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'], mais ceci peut être changé avec la méthode setUri() ou le paramètre de constructeur de la classe Zend_Soap_AutoDiscover. L'URI doit correspondre à un Zend_Soap_Server qui écoute les requêtes.

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();
}

Auto découverte de classe

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 :

  • Le fichier WSDL généré décrit un service Web de type RPC.

  • Le nom du service crée sera le nom de la classe utilisée.

  • 'http://' .$_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'] est utilisé comme URI où le fichier WSDL est disponible par défaut mais ceci peut être surchargé avec la méthode setUri().

    Cet URI est aussi utilisé comme un espace de nom cible pour tous les noms du service (incluant les types complexes décrits éventuellement).

  • Les méthodes de la classe sont jointes dans un » Port Type.

    $className . 'Port' est utilisé comme nom de Port Type.

  • Chaque méthode de la classe est enregistrée comme une opération.

  • Chaque prototype de méthode génère des messages de requête/réponse correspondants.

    Une méthode peut avoir plusieurs prototypes si des paramètres sont optionnels.

Note: Important !

L'auto génération du fichier WSDL (avec auto découverte de la classe) utilise les blocs de documentation de PHP insérés par le développeur dans ses classes, afin de trouver les types retournés. De ce fait, pour les types scalaires, c'est le seul moyen de les déterminer de manière sûre, et concernant les types de retour des méthodes, c'est le seul moyen de les découvrir (PHP étant faiblement typé).

Ceci signifie que documenter de manière correcte vos classes et méthodes n'est pas seulement une bonne pratique, c'est tout simplement essentiel pour partager vos classes en tant que services SOAP auto générés.

Auto découverte des fonctions

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 :

  • Le fichier WSDL généré décrit un service web de type RPC.

  • Le nom du service crée sera le nom du script analysé (utilisé).

  • 'http://' .$_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME'] est utilisé comme URI pour rechercher le fichier WSDL.

    Cet URI est aussi utilisé comme un espace de nom cible pour tous les noms du service (incluant les types complexes décrits éventuellement).

  • Les fonctions sont encapsulées dans un » Port Type.

    $functionName . 'Port' est utilisé comme nom de Port Type.

  • Chaque fonction est enregistrée comme opération possible.

  • Chaque prototype de fonction génère des messages de requête/réponse correspondants.

    Une fonction peut avoir plusieurs prototypes si des paramètres sont optionnels.

Note: Important!

L'auto génération du fichier WSDL (avec auto découverte des fonctions) utilise les blocs de documentation de PHP insérés par le développeur dans ses fonctions, afin de trouver les types retournés. De ce fait, pour les types scalaires, c'est le seul moyen de les déterminer de manière sûre, et concernant les types de retour des méthodes, c'est le seul moyen de les découvrir (PHP étant faiblement typé).

Ceci signifie que documenter de manière correcte vos fonctions n'est pas seulement une bonne pratique, c'est tout simplement essentiel pour partager vos fonctions en tant que services SOAP auto générés.

Types de donnée auto découverts

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

  • Chaînes strings <-> xsd:string.

  • Entiers PHP <-> xsd:int.

  • Flottants PHP (décimaux) <-> 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) [1] Zend_Soap_AutoDiscoverZend_Soap_Wsdl_Strategy_DefaultComplexTypeZend_Soap_Wsdl_Strategy_Interface$extractComplexTypeZend_Soap_Wsdl sur l'ajout des types complexes .

  • type[] or object[] (c'est-à-dire int[]) <-> basé sur la stratégie des types complexes

  • Void PHP <-> type vide.

  • Si le type n'est pas reconnu en tant que l'un de ceux-ci, alors xsd:anyType est utilisé.

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.

Styles de liaisons WSDL

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();

[1] 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_Application
Introduction
Zend_Application Quick Start
Théorie générale
Exemples
Core Functionality
Available Resource Plugins
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_CodeGenerator
Introduction
Exemples Zend_CodeGenerator
Zend_CodeGenerator Réference
Zend_Config
Introduction
Aspect théorique
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction
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 distributeur
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 démarrage rapide
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Créer un visuel personnalisé en utilisant Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Décorateurs standards fournis avec Zend Framework
Internationaliser un formulaire Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction
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
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
Utilisation avancée de Zend_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
L'autoloader
Autoloaders de ressources
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
En-têtes additionnels
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_Navigation
Introduction
Pages
Containers
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_Reflection
Introduction
Zend_Reflection Exemples
Réference de Zend_Reflection
Zend_Registry
Utiliser le registre
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Vue d'ensemble
Créer des index
Searching an Index
Query Language
Query Construction API
Jeu de caractères
Extensibility
Agir avec Lucene Java
Avancé
Bonnes pratiques
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
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_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project Introduction
Create A Project
Zend Tool Project Providers
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
Validation Messages
Zend_Version
Lire la version de Zend Framework
Zend_View
Introduction
Scripts de contrôleur
Scripts de vue
Aides de vue
Zend_View_Abstract
Migration depuis les versions précédentes
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Configuration système requise par Zend Framework
Introduction
Convention de codage PHP de Zend Framework
Vue d'ensemble
Formatage des fichiers PHP
Conventions de nommage
Style de codage
Zend Framework Performance Guide
Introduction
Chargement des classes
Zend_Db Performance
Internationalisation (i18n) and Localisation (l10n)
View Rendering
Informations de copyright