Previous Next

Zend_XmlRpc_Client

Introduction

Le Zend Framework possède la capacité de consommer des services distants XML-RPC, via la classe Zend_XmlRpc_Client. Ses caractéristiques principales sont la conversion automatique des types entre PHP et XML-RPC, un objet proxy de serveur, et des possibilités d'introspection du serveur.

Appels de méthodes

Le constructeur de Zend_XmlRpc_Client reçoit en premier paramètre l'URL du serveur XML-RPC distant. L'instance retournée pourra alors être utilisée pour appeler n'importe quelle méthode distante.

Pour appeler une méthode distante, utilisez la méthode call() de votre instance. Le code suivant montre un exemple avec le serveur XML-RPC du site de Zend Framework. Vous pouvez l'utiliser pour tester ou explorer les possibilités des composants Zend_XmlRpc.

Example #1 XML-RPC appel de méthodes

call('test.sayHello');

// hello

Le type de la valeur XML-RPC retournée sera automatiquement casté en un type compatible PHP. Dans l'exemple ci-dessus, une string PHP est retournée et immédiatement utilisable.

Le premier paramètre de call() est le nom de la méthode distante à appeler. Si celle-ci demande des paramètres, ceux-ci doivent alors être passés via le deuxième paramètre de call(), sous forme de tableau PHP (array) :

Example #2 XML-RPC appel de méthode avec des paramètres

call('test.sayHello', array($arg1, $arg2));

// $result est un type PHP natif

Le tableau de paramètres peut contenir des types PHP natifs, des objets Zend_XmlRpc_Value, ou bien les deux à la fois.

La méthode call() convertira automatiquement la réponse XML-RPC et retournera un type PHP natif valide. Un objet Zend_XmlRpc_Response pour la valeur de retour sera de même disponible, via un appel à getLastResponse().

Types et conversions

Certaines méthodes distantes requièrent des paramètres. Ceux-ci sont donnés sous forme de tableau PHP à call(). Chaque paramètre est supposé être un type PHP natif qui sera alors lui-même converti, ou alors un objet représentant un type XML-RPC (un objet parmi les Zend_XmlRpc_Value).

Types PHP natifs comme paramètres

Les paramètres passés à call() peuvent être d'un type PHP natif, à savoir string, integer, float, boolean, array, ou object. Dans ce cas, chacun des types sera converti de manière automatique en son type compatible XML-RPC, suivant la table suivante :

PHP et XML-RPC, conversions de types
Type PHP natif XML-RPC type
integer int
double double
boolean boolean
string string
array array
associative array struct
object array

Objets Zend_XmlRpc_Value en tant que paramètres

Les paramètres peuvant aussi être des objets Zend_XmlRpc_Value qui spécifient alors exactement un type XML-RPC. Les raisons principales d'utiliser un tel procédé sont :

  • Lorsque vous voulez être certain du type de paramètre (la méthode attend un entier et vous le récupérez sous forme de chaine de caractères depuis une base de données)

  • Lorsque la méthode attend un type base64 ou dateTime.iso8601 (ceux-ci n'existant pas nativement dans le langage PHP).

  • Lorsque la conversion de types (cast) peut échouer (vous voulez passer une valeur XML-RPC vide comme paramètre. Mais les valeurs vides en PHP sont représentés sous forme de tableaux vides, or si vous passez un tableau vide à votre méthode call, il va être converti en un tableau XML-RPC, comme ce n'est pas un tableau associatif).

Deux manières existent pour créer des objets Zend_XmlRpc_Value : instanciez une sous-classe Zend_XmlRpc_Value directement, ou utilisez une fabrique (factory method) telle que Zend_XmlRpc_Value::getXmlRpcValue().

Objets Zend_XmlRpc_Value comme types XML-RPC
XML-RPC Type Zend_XmlRpc_Value Constante Zend_XmlRpc_Value Objet
int Zend_XmlRpc_Value::XMLRPC_TYPE_INTEGER Zend_XmlRpc_Value_Integer
double Zend_XmlRpc_Value::XMLRPC_TYPE_DOUBLE Zend_XmlRpc_Value_Double
boolean Zend_XmlRpc_Value::XMLRPC_TYPE_BOOLEAN Zend_XmlRpc_Value_Boolean
string Zend_XmlRpc_Value::XMLRPC_TYPE_STRING Zend_XmlRpc_Value_String
base64 Zend_XmlRpc_Value::XMLRPC_TYPE_BASE64 Zend_XmlRpc_Value_Base64
dateTime.iso8601 Zend_XmlRpc_Value::XMLRPC_TYPE_DATETIME Zend_XmlRpc_Value_DateTime
array Zend_XmlRpc_Value::XMLRPC_TYPE_ARRAY Zend_XmlRpc_Value_Array
struct Zend_XmlRpc_Value::XMLRPC_TYPE_STRUCT Zend_XmlRpc_Value_Struct

Note: Conversion automatique

Lorsque vous créez un objet Zend_XmlRpc_Value, sa valeur est déterminée par un type PHP. Celui-ci va être converti vers le type désiré en utilisant le cast PHP. Par exemple si une chaîne de caractères est donnée comme valeur à un objet Zend_XmlRpc_Value_Integer, elle sera alors convertie suivant la règle (int)$value.

Objet proxy du serveur

Un autre moyen d'appeler des méthodes avec un client XML-RPC est d'utiliser le proxy du serveur. C'est un objet PHP qui proxie un espace de nom XML-RPC, en fonctionnant autant que possible comme les objets PHP.

Pour instancier un proxy serveur, appelez getProxy() de Zend_XmlRpc_Client. Elle retourne un objet Zend_XmlRpc_Client_ServerProxy. Tout appel de méthode sur l'objet proxy sera proxié vers le serveur XML-RPC, et les paramètres seront utilisés comme pour une méthode PHP banale.

Example #3 Proxy espace de nom par défaut

getProxy();           // Proxy l'espace de nom par défaut

$hello = $server->test->sayHello(1, 2);  // test.Hello(1, 2) retourne "hello"

La méhode getProxy() reçoit un argument optionnel désignant l'espace de nom à utiliser par le proxy. Par défaut, il s'agit de l'espace général, voici un exemple utilisant un espace de nom test:

Example #4 Proxy un espace de nom

getProxy('test');     // Proxy l'espace de nommage "test"

$hello = $test->sayHello(1, 2);         // test.Hello(1,2) retourne "hello"

Si le serveur distant supporte les espaces de nommage imbriqués, alors le proxy les supportera. Par exemple, si le serveur dans l'exemple ci-dessus acceptait les espaces de noms imbriqués, alors sa méthode test.foo.bar() aurait pu être appelée via $test->foo->bar().

Gestion des erreurs

Deux types d'erreurs peuvent être distingués : erreurs HTTP, ou erreurs XML-RPC. L'objet Zend_XmlRpc_Client reconnait ces erreurs et fournit les moyens de les repérer et de les gérer.

Erreurs HTTP

Si une erreur HTTP survient, par exemple le serveur renvoie un 404 Not Found, alors une Zend_XmlRpc_Client_HttpException sera levée.

Example #5 Gérer les erreurs HTTP

call('bar', array($arg1, $arg2));

} catch (Zend_XmlRpc_Client_HttpException $e) {

    // $e->getCode() retourne 404
    // $e->getMessage() retourne "Not Found"

}

Quelque soit l'utilisation du client XML-RPC, une Zend_XmlRpc_Client_HttpException sera systématiquement levée lorsqu'une erreur HTTP de quelque type que ce soit est rencontrée.

Erreurs XML-RPC (Faults)

Une erreur XML-RPC peut être assimilée à une exception en PHP. C'est un type spécial retourné par une des méthodes du client XML-RPC, et ce type contient un message, et un code d'erreur. Les erreurs XML-RPC seront gérées différemment en fonction du contexte d'utilisation de l'objet Zend_XmlRpc_Client.

Lors de l'utilisation de la méthode call(), ou de l'objet proxy serveur, une erreur XML-RPC aura pour effet de lancer une Zend_XmlRpc_Client_FaultException. Le code et le message de l'exception seront rendus dans leurs valeurs respectives de la réponse XML-RPC.

Example #6 Gérer les erreurs XML-RPC

call('badMethod');

} catch (Zend_XmlRpc_Client_FaultException $e) {

    // $e->getCode() retourne 1
    // $e->getMessage() retourne "Unknown method"

}

En utilisant call(), une exception Zend_XmlRpc_Client_FaultException sera donc lancée si une erreur survient. Un objet Zend_XmlRpc_Response contenant l'erreur sera de même disponible via la méthode getLastResponse().

Lors de l'utilisation de la méthode doRequest(), aucune exception ne sera levée si une erreur XML-RPC survient. Simplement, l'objet Zend_XmlRpc_Response retourné contiendra l'erreur. Vérifiez-en l'état avec isFault().

Introspection du serveur

Certains serveurs XML-RPC supportent l'introspection de leurs méthodes au travers de l'espace de noms system. Zend_XmlRpc_Client fournit un support d'un tel procédé.

Une instance de Zend_XmlRpc_Client_ServerIntrospection sera retournée si vous appelez la méthode getIntrospector() sur l'objet Zend_XmlRpcClient.

De la requête à la réponse

Dans les faits, la méthode call() de Zend_XmlRpc_Client fabrique un objet Zend_XmlRpc_Request et l'envoie à une méthode doRequest(), qui retourne un objet de réponse Zend_XmlRpc_Response.

La méthode doRequest() est disponible directement si besoin :

Example #7 Effectuer une requête et récupérer une réponse manuellement

setMethod('test.sayHello');
$request->setParams(array('foo', 'bar'));

$client->doRequest($request);

// $server->getLastRequest() retoure instanceof Zend_XmlRpc_Request
// $server->getLastResponse() retourne instanceof Zend_XmlRpc_Response

Lorsqu'une méthode XML-RPC est appelée, quelqu'en soit le moyen, (call(), doRequest() ou proxy serveur), le dernier objet de requête, et son homologue de réponse, seront toujours disponibles, au travers des appels à getLastRequest() et getLastResponse().

Client HTTP et tests

Dans tous les exemples utilisés sur cette page, nous ne parlons jamais du client HTTP. Lorsque c'est nécessaire, une instance de Zend_Http_Client sera créée par défaut et injectée dans Zend_XmlRpc_Client de manière automatique.

L'objet client HTTP peut être récupéré à tout moment grâce à la méthode getHttpClient(). setHttpClient() permet d'injecter un objet Zend_Http_Client.

setHttpClient() est particulièrement utilisée pour les tests unitaires. Lorsque combinée avec Zend_Http_Client_Adapter_Test, les services webs peuvent être déguisés (émulés) pour les tests. Voyez les tests unitaires de Zend_XmlRpc_Client pour des exemples concrets.

Previous Next
Introduction to Zend Framework
Présentation
Installation
Zend_Acl
Introduction
Affiner les Contrôles d'Accès
Utilisation avancée
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
La théorie du cache
Les frontends Zend_Cache
Les backends Zend_Cache
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
Introduction
Point de vue théorique
Zend_Config_Ini
Zend_Config_Xml
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 : Zend_Controller_Router_Rewrite
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
Point de vue 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
Validators for Zend_File_Transfer
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 à Gdata
Authentification par procédé AuthSub
Authentification avec ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Utiliser l'API YouTube
Utilisation des albums Web Picasa
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 Languages for Locales
Supported Regions for Locales
Zend_Log
Présentation
Rédacteurs (Writers)
Formateurs (mise en forme)
Filtres
Zend_Mail
Introduction
Envoyer des emails en utilisant SMTP
Envoyer plusieurs emails par connexion SMTP
Utiliser différents transports
Email 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 emails
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
Usage
Configuration
Advanced usage
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_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
Character Set
Extensibility
Interoperating with Java Lucene
Advanced
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_Yahoo
Zend_Session
Introduction
Usage basique
Utilisation avancée
Global Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Translate
Introduction
Adaptateurs pour Zend_Translate
Utiliser les adaptateurs de traduction
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Classes de validation standard
Chaînes de validation
Ecrire 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
Informations de copyright