Un client SOAP PHP con NuSOAP

Lavorando con PHP esistono diversi modi di implementare un web service. Abbiamo a disposizione l'estensione SOAP standard, che è probabilmente la scelta migliore se possiamo configurare Apache come vogliamo, in modo da abilitare l'estensione sul modulo PHP di Apache. Questo scenario d'uso è ben documentato sul web quindi eviteremo di ripeterlo qui. Preferiamo invece introdurre una scelta leggera, possibile grazie alla libreria NuSOAP, che presenta il vantaggio di poter essere usata “al volo”, senza toccare la configurazione né di Apache né di PHP. Chi non conoscesse i servizi SOAP o fosse digiuno di web services, puoi dare un'occhiata a questo articolo prima di proseguire.

Configurazione

Per utilizzare NuSOAP è sufficiente scaricare la libreria e copiarla direttamente tra le cartelle del nostro sito, in modo che sia accessibile mediante la direttiva PHP include o require_once.

Lato server

Dopo aver verificato di raggiungere la libreria NuSOAP possiamo creare una pagina PHP che contenga il codice del web service vero e proprio, che potrebbe essere un semplice HelloWorld

<?php

require_once("../nusoap-0.9.5/lib/nusoap.php");

$server = new soap_server();

$server->configureWSDL('hellowsdl', 'tns:hellowsdl');

$server->register('hello',

array('name' => 'xsd:string'),

array('return' => 'xsd:string'),

'tns:hellowsdl',

'tns:hellowsdl#hello',

'rpc',

'encoded',

'Returns hello name'

);

function hello($name) { return 'Hello, ' . $name.' !!!'; }

$HTTP_RAW_POST_DATA = isset($HTTP_RAW_POST_DATA) ? $HTTP_RAW_POST_DATA : '';

$server->service($HTTP_RAW_POST_DATA);

?>

il codice dovrebbe essere abbastanza chiaro e si commenta da sé. Notiano il riferimento al file nusoap.php che include la libreria NuSOAP, e l'uso del comando configureWSDL che si occupa di servire il documento WSDL quando interroghiamo l'URL del web service (che a rigore si chiama endpoint), ad esempio

http://localhost/soap/server/hellowsdl.php

Lato client

Il codice di un client che consuma il servizio HelloWorld potrebbe essere

<?php

require_once("nusoap-0.9.5/lib/nusoap.php");

$client = new nusoap_client('http://localhost/soap/server/hellowsdl.php?wsdl', true);

$err = $client->getError();

if ($err) echo '<h2>Constructor error</h2><pre>'.$err.'</pre>';

$result = $client->call('hello', array('name' => 'Pippo'));

if ($client->fault) {

// Manage error

}

echo '<h2>Request</h2>';

echo '<pre>'.htmlspecialchars($client->request, ENT_QUOTES).'</pre>';

echo '<h2>Response</h2>';

echo '<pre>'.htmlspecialchars($client->response, ENT_QUOTES).'</pre>';

echo '<h2>Debug</h2>';

echo '<pre>'.htmlspecialchars($client->debug_str, ENT_QUOTES).'</pre>';

?>

anche qui includiamo il file nusoap.php, come nel server. Portiamo l'attenzione sui seguenti passaggi

• La chiamata vera e propria è $client->call(...) , dove vengono passati anche i parametri della request SOAP: nell'esempio qui sopra viene passato il parametro name con valore Pippo
• La documentazione ufficiale di NuSOAP suggerisce di usare il costruttore soapclient per creare l'oggetto $client: qui preferiamo usare nusoap_client (che è un alias dello stesso costruttore) per evitare ambiguità nel caso della presenza di altre estensioni SOAP. Per chiarimenti basta dare un'occhiata alla fine del file nusoap.php
• Nel caso di connessione https con certificato Self-Signed, il codice qui sopra dovrebbe funzionare subito (a patto ovviamente di specificare l'endpoint corretto): questo perché NuSOAP si occupa, in modo trasparente all'utente, di richiedere il certificato e aprire la connessione https