PHP
SOAP Client

Sintassi

• __getFunctions () // Restituisce l'array di funzioni per il servizio (solo modalità WSDL)
• __getTypes () // Restituisce l'array di tipi per il servizio (solo modalità WSDL)
• __getLastRequest () // Restituisce XML dall'ultima richiesta (richiede l'opzione di trace )
• __getLastRequestHeaders () // Restituisce le intestazioni dall'ultima richiesta (richiede l'opzione di trace )
• __getLastResponse () // Restituisce XML dall'ultima risposta (richiede l'opzione di trace )
• __getLastResponseHeaders () // Restituisce le intestazioni dall'ultima risposta (richiede l'opzione di trace )

Parametri

Osservazioni

$soap->requestInfo(['a', 'b', 'c']);

Modalità WSDL

Innanzitutto, crea un nuovo oggetto SoapClient , passando l'URL al file WSDL e, facoltativamente, una serie di opzioni.

// Create a new client object using a WSDL URL
$soap = new SoapClient('https://example.com/soap.wsdl', [
    # This array and its values are optional
    'soap_version' => SOAP_1_2,
    'compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP,
    'cache_wsdl' => WSDL_CACHE_BOTH,
    # Helps with debugging
    'trace' => TRUE,
    'exceptions' => TRUE
]);

Quindi utilizzare l'oggetto $soap per chiamare i metodi SOAP.

$result = $soap->requestData(['a', 'b', 'c']);

Modalità non WSDL

Questo è simile alla modalità WSDL, tranne che passiamo NULL come file WSDL e assicuratevi di impostare la location e le opzioni uri .

$soap = new SoapClient(NULL, [
    'location' => 'https://example.com/soap/endpoint',
    'uri' => 'namespace'
]);

Classmaps

Quando si crea un client SOAP in PHP, è anche possibile impostare una chiave di classmap nell'array di configurazione. Questa classmap definisce quali tipi definiti nel WSDL devono essere mappati su classi effettive, invece che su StdClass predefinito. Il motivo per cui dovresti farlo è che puoi ottenere il completamento automatico dei campi e delle chiamate ai metodi su queste classi, invece di dover indovinare quali campi sono impostati sul normale StdClass .

class MyAddress {
    public $country;
    public $city;
    public $full_name;
    public $postal_code; // or zip_code
    public $house_number;
}

class MyBook {
    public $name;
    public $author;

    // The classmap also allows us to add useful functions to the objects
    // that are returned from the SOAP operations.
    public function getShortDescription() {
        return "{$this->name}, written by {$this->author}";
    }
}

$soap_client = new SoapClient($link_to_wsdl, [
    // Other parameters
    "classmap" => [
        "Address" => MyAddress::class, // ::class simple returns class as string
        "Book" => MyBook::class,
    ]
]);

Dopo aver configurato la mappa di classe, ogni volta che si esegue una determinata operazione che restituisce un tipo Address o Book , SoapClient crea un'istanza di quella classe, riempie i campi con i dati e li restituisce dalla chiamata all'operazione.

// Lets assume 'getAddress(1234)' returns an Address by ID in the database
$address = $soap_client->getAddress(1234);

// $address is now of type MyAddress due to the classmap
echo $address->country;

// Lets assume the same for 'getBook(1234)'
$book = $soap_client->getBook(124);

// We can not use other functions defined on the MyBook class
echo $book->getShortDescription();

// Any type defined in the WSDL that is not defined in the classmap
// will become a regular StdClass object
$author = $soap_client->getAuthor(1234);

// No classmap for Author type, $author is regular StdClass.
// We can still access fields, but no auto-completion and no custom functions
// to define for the objects.
echo $author->name;

Tracciare la richiesta e la risposta SOAP

A volte vogliamo vedere cosa viene inviato e ricevuto nella richiesta SOAP. I seguenti metodi restituiranno l'XML nella richiesta e nella risposta:

SoapClient::__getLastRequest()
SoapClient::__getLastRequestHeaders()
SoapClient::__getLastResponse()
SoapClient::__getLastResponseHeaders()

Ad esempio, supponiamo di avere una costante ENVIRONMENT e quando il valore di questa costante è impostato su DEVELOPMENT vogliamo getAddress tutte le informazioni quando la chiamata a getAddress genera un errore. Una soluzione potrebbe essere:

try {
    $address = $soap_client->getAddress(1234);
} catch (SoapFault $e) {
    if (ENVIRONMENT === 'DEVELOPMENT') {
        var_dump(
            $soap_client->__getLastRequestHeaders()
            $soap_client->__getLastRequest(),
            $soap_client->__getLastResponseHeaders(),
            $soap_client->__getLastResponse()
        );
    }
    ...
}