Desarrollo #programming#php#soap 4 min

PHP5: pasando y devolviendo objetos como parámetro en una llamada SOAP (Parte II)

Traducción del original en catalán. Léela en: CatalàEnglish

Parte 3 de 3Servicios web SOAP con PHP5
  1. PHP5 - Generando WSDL con Zend Studio 5.1
  2. PHP5: pasando objetos como parámetro en una llamada SOAP
  3. PHP5: pasando y devolviendo objetos como parámetro en una llamada SOAP (Parte II)

El mes de marzo escribí un artículo titulado casi igual que este, en aquel artículo explicaba cómo se las apañaba PHP5 para recibir y devolver tipos complejos (p.e. objetos) como parámetros de llamadas SOAP. Pues bien, había encontrado una cosa que me tenía un poco mosca y es que cuando enviaba un objeto del cliente hacia el servidor o al revés perdía el tipo. Pues bien, esta tarde he descubierto cómo conseguir hacer eso sin perder el tipo. Ya sabéis que cuando se me mete una cosa en la cabeza...

El tema no es sencillo y el generador de WSDL del ZendStudio es un poco tiquismiquis haciendo estas cosas, así que hay que hacerlo todo muy mono para que lo entienda el generador WSDL. De hecho, la gracia está en definir el tipo complejo dentro del fichero WSDL, por eso el generador necesita que le demos toda la información como él quiere, si no no es capaz de generar bien el fichero.

En el ejemplo que os pongo a continuación he creado la clase persona con tres atributos, dos públicos y uno privado. El privado, al contrario de lo que comentaba en el artículo anterior, no pierde su valor. Así pues, en principio tenemos el objeto 100% replicado con el método que ahora os explicaré.

La clase persona:

<?php
/**
 * classe persona
 *
 */
class persona {
	/**
	 * propietat nom
	 *
	 * @var string $nom
	 * @var string $cognom
	 * @var string $dni
	 */
	public $nom;
	private $cognom;
	public $dni;
	/**
	 * setter function
	 *
	 * @param string $nom
	 */
	function set($nom) {
		$this-?>nom=$nom;
	}
	/**
	 * setter cognom
	 *
	 *  @param string $cognom
	 */
	function setCognom($cognom)
	{
		$this-?>cognom=$cognom;
	}
	/**
	 * getter function
	 *
	 * @return string valor a tornar
	 */
	function get()
	{
		return $this-?>nom;
	}
	/**
	 * getter cognom
	 *
	 * @return string valor a tornar
	 */
	function getCognom()
	{
		return $this-?>cognom;
	}
}
?>

Fijaos que comentamos el código según la sintaxis del phpDoc, eso se hace porque es de estos comentarios de donde el generador WSDL extraerá los tipos de las variables para poder exportarlas sin perder información. La propiedad dni no tiene ni getter ni setter porque accederemos a ella directamente. Por lo demás es una clase completamente normal y sencilla.

El servidor es bastante simple:

<?php
require_once("persona.class.php");
/**
 * servidor soap
 *
 */
class soapservice {
	/**
	 * funcio soap publicada
	 *
	 * @param persona $per
	 * @return persona
	 */
	function peticion($per) {
		$per->dni="38147000x";
		return $per;
  }
}
	$server = new SoapServer("server.wsdl",array("classmap"=>array("persona"=>"persona")));
$server->setClass("soapservice");
$server->handle();
?>

Comentar que la clase soapservice recibe un objeto de tipo persona, añade un valor a la propiedad dni y devuelve el mismo objeto. Aquí también tenemos que documentar el código según la sintaxis del phpDoc, así el modelo WSDL nos dirá explícitamente el tipo de los objetos que recibe y devuelve el método peticion.

Por lo que se refiere a la creación del objeto server del tipo SoapServer, fijaos que mapeamos con la opción classmap el objeto de tipo persona que se pasa como parámetro con la clase local también llamada persona. Gracias a ese mapeo, cuando recibimos el objeto per en el soapservice, este ya es del tipo persona.

Ahora toca ver el código del cliente, este código también tiene un mapeo igual que el del servidor de SOAP, pero en este caso sirve para capturar la salida del servidor y, como el objeto que se devuelve a la salida también es del tipo persona, el classmap es igual que el del servidor.

<?php
require_once("persona.class.php");
// creem objecte tipus persona
$myPersona=new persona;
$myPersona->set("el_nom");
$myPersona->setCognom("el_cognom");
	$client = new SoapClient("server.wsdl",array("classmap"=>array("persona"=>"persona")));
	$localPersona=$client->peticion($myPersona);
	var_dump($client->__getFunctions());
print_r($localPersona);
echo $localPersona->getCognom();
?>

Una de las cosas interesantes que hacemos es preguntar qué funciones se están publicando en el servidor SOAP. Esa información está descrita en el WSDL y la función __getFunctions() nos la formatea para humanos. Así pues podemos ver que está disponible la función peticion, que tiene como parámetro un objeto del tipo persona y que devuelve otro objeto de ese tipo.

array(1) {
  [0]=>
  string(30) "persona peticion(persona $per)"
}

Después mostramos (print_r) el objeto localPersona que nos ha devuelto la llamada al método peticion (localPersona=localPersona=client->peticion($myPersona);):

persona Object
(
    [nom] => el_nom
)

Finalmente hacemos una prueba de concepto y obtenemos el valor de la propiedad nom a través del getter, o sea, echo $localPersona->getCognom();:

el_nom 

Como podéis ver ha quedado bien demostrado que es relativamente sencillo enviar y recibir tipos complejos a través de los servicios SOAP. Toda la gracia está en el fichero WSDL, a continuación os pego el que me ha generado el Zend Studio para hacer estas pruebas, fijaos cómo al principio de todo lo primero que hace es declarar el tipo complejo de datos que tiene que traspasar, en nuestro caso la clase persona.

<?xml version='1.0' encoding='UTF-8'?>
	<!-- WSDL file generated by Zend Studio. -->
	<definitions name="server" targetNamespace="urn:server" xmlns:typens="urn:server" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:typens0="http://oriol.joor.net/fotoprix/web/cu.php/soap/server">
	<types>
		<xsd:schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:server">
			<xsd:complexType name="persona">
				<xsd:all>
					<xsd:element name="nom" type="xsd:string"/>
					<xsd:element name="cognom" type="xsd:string"/>
					<xsd:element name="dni" type="xsd:string"/>
				</xsd:all>
			</xsd:complexType>
		</xsd:schema>
	</types>
	<message name="peticion">
		<part name="per" type="typens:persona"/>
	</message>
	<message name="peticionResponse">
		<part name="peticionReturn" type="typens:persona"/>
	</message>
	<portType name="soapservicePortType">
		<documentation>
			servidor soap
		</documentation>
		<operation name="peticion">
			<documentation>
				provem de descriure
			</documentation>
			<input message="typens:peticion"/>
			<output message="typens:peticionResponse"/>
		</operation>
	</portType>
	<binding name="soapserviceBinding" type="typens:soapservicePortType">
		<soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
		<operation name="peticion">
			<soap:operation soapAction="urn:soapserviceAction"/>
			<input>
				<soap:body namespace="urn:server" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
			</input>
			<output>
				<soap:body namespace="urn:server" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
			</output>
		</operation>
	</binding>
	<service name="serverService">
		<port name="soapservicePort" binding="typens:soapserviceBinding">
			<soap:address location="http://oriol.joor.net/soap/server.php"/>
		</port>
	</service>
</definitions>