skip to main | skip to sidebar
Code 18
Manuel du savoir-faire à l'usage des geeks et des curieux
RSS
  • Accueil
  • Le web au Québec
  • Liens
  • Twitter
  • Facebook
  • À propos

mardi 22 juin 2010

SOAP en PHP : retourner un objet ou array ?

Publié par Infinite Loop, à 19 h 20 3 commentaires

Un lecteur (Emmanuel) m'a écrit pour me demander si je pouvais l'aider à faire fonctionner son service web PHP SOAP réalisé avec les composants du Zend Framework. En effectuant des recherches pour sa solution, il a trouvé mon article qui explique comment créer un WSDL facilement. Il a tenté de transposer mon exemple sur son projet mais mis à part faire apparaître le WSDL (serveur.php?wsdl), il n'arrivait pas à se connecter au service avec un client.

J'ai accepté de lui donner un coup de pouce mais au risque de me répéter, je lui ai d'abord demandé s'il avait lu la suite de mon article qui donnait quelques précisions sur l'article original : commentaire sur la création de WSDL en PHP.

En effet, il l'avait consulté et m'a expliqué, à l'aide d'un exemple concret, la nature du problème. Essentiellement, sa fonction appelée depuis le service web retourne un objet nommé Response et qu'il n'arrive pas à le récupérer côté client. La classe peut être définie sommairement comme suit :

class Response{
/** @var bool */
private $returnValue;

/** @var string */
private $errCode;

/** @var string */
private $errMessage;

/* plusieurs fonctions */
}
En retournant l'objet, impossible de le récupérer côté client. Pourtant, tout est 100% fonctionnel s'il retourne un simple int, string, float, etc. Son intuition : définir dans le WSDL un type complexe qui correspondrait à l'objet retourné. J'avoue ne pas y avoir pensé et ne pas avoir expérimenté. Mais j'avais un doute que ce soit possible car l'objet possède des fonctions qui ne seraient pas prises en charge au moment du retour. Peut-être que je me trompe et que c'est possible ? À ma connaissance, le but d'un service web est d'offrir une interface standard pour être appelée à partir de n'importe quel langage de programmation. Ce qui sous-entend qu'on recevra des valeurs et non pas des objets.

Ma recommandation a été de lui suggérer de contourner le problème en utilisant une valeur de retour de type "array" associatif. Ainsi, sa classe Response offrirait une fonction pour récupérer les valeurs :
class Response{
/** @var bool */
private $returnValue;

/** @var string */
private $errCode;

/** @var string */
private $errMessage;

public function __construct(){
// à titre d'exemple...
$this->returnValue = true;
$this->errCode = 404;
$this->errMessage = 'Page not found';
}

public function getValues(){
$arrToReturn =
array(
'returnValue' => $this->returnValue,
'errCode' => $this->errCode,
'errMessage' => $this->errMessage
);

return $arrToReturn;
}
}
Dans la classe qui sera inspectée par AutoDiscover, j'ajoute une fonction :
/**
* Return array structure
* @return array
*/
public function getResponseStructure(){
$obj = new Response();
return $obj->getValues();
}
Alors que du côté client, je peux récupérer les valeurs selon les clés :
$client = new Zend_Soap_Client('http://wsdl.localhost/service.php?wsdl');
$response = $client->getResponseStructure();

print_r($response);

/*
echo $response['returnValue'] . "\n";
echo $response['errCode'] . "\n";
echo $response['errMessage'] . "\n";
*/
En sortie de print_r() :
(
[returnValue] => 1
[errCode] => 404
[errMessage] => Page not found
)
Ceci devrait suffire pour obtenir les valeurs correctement. Si quelqu'un sait s'il est possible de retourner réellement un objet, je serais preneur pour la solution.


Tags: PHP, Zend Framework

3 réponses à "SOAP en PHP : retourner un objet ou array ?"

  1. jeg a dit...
    23 juin 2010 à 05 h 46

    Bonjour,

    C'est possible de retourner, mais il faut procéder de la manière suivante :
    - création de l'objet correspondant dans le WSDL (Eclipse fourni une très belle interface pour faire cela).
    - utiliser l'API SOAP fourni en standard avec php 5 (la version est stable au moins en 5.2.13) et c'est parti.

    Je n'ai pas d'exemple sous le coude, ça peut s'arranger si il y a du monde d'intéressé :-)

    Infinite Loop a dit...
    23 juin 2010 à 06 h 28

    Oui, un court exemple serait pertinent à publier.

    Je serais d'autant plus intéressé à savoir si le composant Zend Framework est compatible avec le retour d'objet ou s'il est limité.

    Gilles Doge a dit...
    29 novembre 2011 à 13 h 40

    Il est possible d'utiliser des types complexes comme paramètre ou retour de méthode avec Zend_Soap_AutoDiscover.

    En changeant la stratégie de type complexe il est même possible d'utiliser des Array de type complexe.

    Le tout est de bien documenter les méthodes. Exemple:

    ```

    class Response {
    /** @var bool */
    private $returnValue;

    /** @var string */
    private $errCode;

    /** @var string */
    private $errMessage;

    /* plusieurs fonctions */
    }

    /**
    * Return array structure
    * @return Response
    */
    public function getResponseStructure(){
    return new Response();
    }

    /* Et si on utilise la stratégie :
    $server->setComplexStrategy('Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex');
    */

    // on peut faire des trucs genre
    /**
    * Return array structure
    * @return Response[]
    */
    public function getArrayResponseStructure(){
    return array(new Response(), new Response());
    }
    ```

    Pour véritablement récupérer une instance de la classe Response coté client (sauf erreur le comportement par défaut et d'utiliser stdClass) il faut configurer le client en définissant l'option 'classmap':

    ```
    $client = new SoapClient($wsdl, array(
    'classmap' => array(
    'Response' => 'Response'
    )
    ));
    ```

    Il faut bien entendu que la classe Response existe aussi coté client.

    Cordialement,
    Gilles

    PS: Les codes ci-dessus n'ont pas été testé et son juste à titre indicatif.


Publier un commentaire

Message plus récent Messages plus anciens Accueil
S'abonner à : Publier des commentaires (Atom)
    Suivre @code18 sur Twitter

    Catégories

    • Apache (21)
    • Citations (167)
    • Club Vidéo (24)
    • Coffre à outils (56)
    • CSS (8)
    • Curiosités (117)
    • Design Pattern (2)
    • Drupal (8)
    • Easter Eggs (22)
    • Extensions Firefox (20)
    • GIMP (7)
    • Histoire (21)
    • HTML (32)
    • Humour (57)
    • Intégration (34)
    • iPod (12)
    • JavaScript (110)
    • Jeu de combat (6)
    • Le coin du geek (128)
    • Liens (12)
    • Linux (56)
    • Livres (78)
    • Lois et principes (46)
    • Marché des saveurs (26)
    • Mathématique (18)
    • Mobile (5)
    • Montréal (32)
    • Musique (112)
    • Pancartes et écriteaux (16)
    • Perl (8)
    • Pérou (1)
    • PHP (130)
    • PostgreSQL (44)
    • Programmation (105)
    • Saviez-vous que (55)
    • Sécurité (22)
    • SEO (5)
    • SQL Server (22)
    • Vieilles publicités (6)
    • Virtualisation (8)
    • Voyages (1)
    • Zend Framework (26)

    Divers

    Archives

    • ►  2015 (6)
      • ►  août 2015 (1)
      • ►  juillet 2015 (1)
      • ►  février 2015 (3)
      • ►  janvier 2015 (1)
    • ►  2014 (8)
      • ►  décembre 2014 (1)
      • ►  novembre 2014 (1)
      • ►  octobre 2014 (1)
      • ►  août 2014 (2)
      • ►  juillet 2014 (2)
      • ►  janvier 2014 (1)
    • ►  2013 (53)
      • ►  décembre 2013 (2)
      • ►  novembre 2013 (1)
      • ►  octobre 2013 (3)
      • ►  septembre 2013 (2)
      • ►  août 2013 (5)
      • ►  juillet 2013 (3)
      • ►  juin 2013 (5)
      • ►  mai 2013 (3)
      • ►  avril 2013 (7)
      • ►  mars 2013 (7)
      • ►  février 2013 (11)
      • ►  janvier 2013 (4)
    • ►  2012 (105)
      • ►  décembre 2012 (8)
      • ►  novembre 2012 (5)
      • ►  octobre 2012 (4)
      • ►  septembre 2012 (1)
      • ►  août 2012 (8)
      • ►  juillet 2012 (7)
      • ►  juin 2012 (7)
      • ►  mai 2012 (10)
      • ►  avril 2012 (13)
      • ►  mars 2012 (15)
      • ►  février 2012 (15)
      • ►  janvier 2012 (12)
    • ►  2011 (146)
      • ►  décembre 2011 (14)
      • ►  novembre 2011 (11)
      • ►  octobre 2011 (12)
      • ►  septembre 2011 (13)
      • ►  août 2011 (15)
      • ►  juillet 2011 (17)
      • ►  juin 2011 (18)
      • ►  mai 2011 (15)
      • ►  avril 2011 (9)
      • ►  mars 2011 (7)
      • ►  février 2011 (3)
      • ►  janvier 2011 (12)
    • ▼  2010 (398)
      • ►  décembre 2010 (29)
      • ►  novembre 2010 (28)
      • ►  octobre 2010 (32)
      • ►  septembre 2010 (34)
      • ►  août 2010 (22)
      • ►  juillet 2010 (35)
      • ▼  juin 2010 (42)
        • L'art de l'ordinateur analogique
        • L'effet du deuxième système de Brooks
        • La vérité sur la gestion de projets
        • Simulation de combat - Étape 6
        • Citation no. 88 sur la politique
        • Faire de la musique avec un bonzaï
        • Simulation de combat - Étape 5
        • Musique métal : CTRL+C, CTRL+V
        • Bande-annonce de Java 4-ever
        • Histoire de Saint-Jean-Baptiste
        • Zone réservée aux chaises roulantes
        • Mais qu'est-ce qu'Adobe veut dire ?
        • SOAP en PHP : retourner un objet ou array ?
        • 1er Tweet de Google en binaire
        • Utilisation CSS de @font-face avec OpenType
        • Citation no. 87 sur la dépression
        • Japadog : hot dog à la japonaise
        • Exclure un domaine d'une campagne AdWords
        • Plus aucune raison de croire à ça en 2010 !
        • Décharger les idées de ma tête
        • Ajouter un ancre hash tag dynamiquement
        • Retour sur l'anti-conférence pour un Web musical Q...
        • Deux erreurs d'inattention à l'intégration
        • Chocolat pour les geeks
        • PHP : preg_replace() et le symbole $ comme valeur
        • Un montréalais en tourisme à Montréal
        • Citation no. 86 sur Linux et Windows
        • Trois lois de la robotique d'Asimov
        • Expérimentations Canvas HTML 5 et JavaScript
        • Joke informatique dans un livre
        • Démystifier le dollar américain
        • HTML 5 et CSS - Astuce pour coder plus vite
        • Sac de chips extrêmes format géant
        • Fin du 17ème Mondial de la bière de Montréal
        • Laptop Toshiba - Réinitialisation "out of the box"
        • Citation no. 85 sur l'alcool
        • Branchement Digitech RP155 sur l'ordinateur
        • Réflexion sur la suite de Fibonacci (PHP)
        • Fonction strip_tags pour PostgreSQL
        • C'est là que la chicane a pognée...
        • Illusion d'optique impossible
        • Convertir du Flash à HTML 5 et JavaScript
      • ►  mai 2010 (36)
      • ►  avril 2010 (37)
      • ►  mars 2010 (34)
      • ►  février 2010 (32)
      • ►  janvier 2010 (37)
    • ►  2009 (430)
      • ►  décembre 2009 (32)
      • ►  novembre 2009 (34)
      • ►  octobre 2009 (33)
      • ►  septembre 2009 (37)
      • ►  août 2009 (37)
      • ►  juillet 2009 (39)
      • ►  juin 2009 (38)
      • ►  mai 2009 (37)
      • ►  avril 2009 (35)
      • ►  mars 2009 (37)
      • ►  février 2009 (32)
      • ►  janvier 2009 (39)
    • ►  2008 (84)
      • ►  décembre 2008 (34)
      • ►  novembre 2008 (39)
      • ►  octobre 2008 (11)

    Abonnés

Copyright © All Rights Reserved. Code 18 | Converted into Blogger Templates by Theme Craft