PHP
Client SOAP

Syntaxe

• __getFunctions () // Retourne un tableau de fonctions pour le service (mode WSDL uniquement)
• __getTypes () // Renvoie un tableau de types pour le service (mode WSDL uniquement)
• __getLastRequest () // Renvoie le code XML de la dernière demande (option de trace requise)
• __getLastRequestHeaders () // Renvoie les en-têtes de la dernière requête (option de trace requise)
• __getLastResponse () // Retourne le code XML de la dernière réponse (option de trace requise)
• __getLastResponseHeaders () // Renvoie les en-têtes de la dernière réponse (option de trace requise)

Paramètres

Remarques

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

Mode WSDL

Tout d'abord, créez un nouvel objet SoapClient , en transmettant l'URL au fichier WSDL et éventuellement un tableau d'options.

// 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
]);

Utilisez ensuite l'objet $soap pour appeler vos méthodes SOAP.

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

Mode non WSDL

Ceci est similaire au mode WSDL, sauf que nous passons NULL tant que fichier WSDL et que nous nous assurons de définir l' location et les options de l' uri .

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

Classmaps

Lors de la création d'un client SOAP en PHP, vous pouvez également définir une clé de classmap dans le tableau de configuration. Cette classmap définit les types définis dans le WSDL qui doivent être mappés sur les classes réelles, au lieu du StdClass par défaut. La raison pour laquelle vous souhaitez le faire est que vous pouvez obtenir une complétion automatique des champs et des appels de méthode sur ces classes, au lieu d'avoir à deviner quels champs sont définis sur le StdClass normal.

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,
    ]
]);

Après avoir configuré le classmap, chaque fois que vous effectuez une opération spécifique renvoyant un type Address ou Book , SoapClient instanciera cette classe, remplira les champs avec les données et les renverra de l'appel d'opération.

// 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;

Suivi des requêtes et des réponses SOAP

Parfois, nous voulons voir ce qui est envoyé et reçu dans la requête SOAP. Les méthodes suivantes renverront le code XML dans la requête et la réponse:

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

Par exemple, supposons que nous ayons une constante ENVIRONMENT et que la valeur de cette constante est définie sur DEVELOPMENT nous voulons faire écho à toutes les informations lorsque l'appel à getAddress génère une erreur. Une solution pourrait être:

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()
        );
    }
    ...
}