PHP
SOAPクライアント

構文

• __getFunctions（） //サービス用の関数の配列を返します（WSDLモードのみ）
• __getTypes（） //サービスの型の配列を返します（WSDLモードのみ）
• __getLastRequest（） //最後のリクエストからXMLを返します（ traceオプションが必要です）
• __getLastRequestHeaders（） //最後のリクエストからヘッダを返す（ traceオプションが必要）
• __getLastResponse（） //最後のレスポンスからXMLを返します（ traceオプションが必要です）
• __getLastResponseHeaders（） //最後のレスポンスのヘッダーを返します（ traceオプションが必要です）

パラメーター

備考

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

WSDLモード

最初に、新しいSoapClientオブジェクトを作成し、URLをWSDLファイルに渡します。オプションで、オプションの配列も渡します。

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

$soapオブジェクトを使用してSOAPメソッドを呼び出します。

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

非WSDLモード

これは、WSDLファイルと同様にNULLを渡し、 locationとuriオプションを設定することを除いて、WSDLモードに似ています。

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

クラスマップ

PHPでSOAPクライアントを作成する場合は、コンフィグレーション配列でclassmapキーを設定することもできます。このclassmapデフォルトの代わりに、WSDLで定義されたタイプは、実際のクラスにマップされるべきかを定義StdClass 。理由は、通常の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,
    ]
]);

クラスマップを構成した後で、 AddressまたはBook型を返す特定の操作を実行するたびに、SoapClientはそのクラスをインスタンス化し、フィールドをデータで埋めて、操作呼び出しから返します。

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

SOAP要求と応答のトレース

SOAPリクエストで送受信される内容を調べたいことがあります。次のメソッドは、要求と応答のXMLを返します。

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

たとえば、 ENVIRONMENT定数があり、この定数の値がDEVELOPMENTに設定されている場合、 getAddressの呼び出しによってエラーがスローされたときにすべての情報をエコーし​​たいとします。 1つの解決策は次のとおりです。

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