SoapVar Constructor - Creating Encoded Values

WSDL Tutorials - Herong's Tutorial Examples

∟SoapVar Constructor - Creating Encoded Values

This section provides a tutorial example on how to create input parameters with type encoded values. Built-in types are XSD_STRING, XSD_BOOLEAN, XSD_DECIMAL, XSD_DATE, XSD_ANYXML, etc.

In the previous tutorial, I tried to specify input parameter names with the SoapParam constructor. It did not work because my WSDL document has parameter names explicitly defined.

In this tutorial, I want test the SoapVar constructor, which can be used to encode strings into SOAP values:

   $value = new SoapVar($string, encoding);

"encoding" should be one of predefined constants like: XSD_STRING, XSD_BOOLEAN, XSD_DECIMAL, XSD_DATETIME, XSD_TIME, XSD_DATE, XSD_ANYURI, XSD_ANYXML, etc.

Here is my testing tutorial program, SoapClient_SoapVar.php:

<?php
# SoapClient_SoapVar.php
# Copyright (c) 2007 HerongYang.com. All Rights Reserved.
#
#- Loading the WSDL document
   $server = "https://www.herongyang.com/Service/";
   $wsdl = $server . "GetStockPrice_WSDL_11_SOAP_11_RPC.wsdl";
   $client = new SoapClient($wsdl,
      array('trace' => TRUE));

#- Test 1: Calling with values directly
   $result = $client->GetStockPrice('GOOG', 'NASDAQ', '2007-07-07');
   print $client->__getLastRequest()."\n";

#- Test 2: Calling with SoapVal objects correct encoding types
   $stock = new SoapVar("GOOG", XSD_STRING);
   $market = new SoapVar("NASDAQ", XSD_STRING);
   $date = new SoapVar("2007-07-07", XSD_DATE);
   $result = $client->GetStockPrice($stock, $market, $date);
   print $client->__getLastRequest()."\n";

#- Test 3: Calling with SoapVal objects with incorrect encoding types
   $stock = new SoapVar("<Stock>GOOG</Stock>", XSD_STRING);
   $market = new SoapVar("<Market>NASDAQ</Market>", XSD_ANYXML);
   $date = new SoapVar("2007-07-07", XSD_DATETIME);
   $result = $client->GetStockPrice($stock, $market, $date);
   print $client->__getLastRequest()."\n";
?>

Here is the result of this tutorial program:

<SOAP-ENV:Envelope ...">
  <SOAP-ENV:Body>
    <SOAP-ENV:GetStockPrice>
      <stockPart xsi:type="xsd:string">GOOG</stockPart>
      <marketPart xsi:type="xsd:string">NASDAQ</marketPart>
      <datePart xsi:type="xsd:date">2007-07-07</datePart>
    </SOAP-ENV:GetStockPrice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<SOAP-ENV:Envelope ...">
  <SOAP-ENV:Body>
    <SOAP-ENV:GetStockPrice>
      <stockPart xsi:type="xsd:string">GOOG</stockPart>
      <marketPart xsi:type="xsd:string">NASDAQ</marketPart>
      <datePart xsi:type="xsd:date">2007-07-07</datePart>
    </SOAP-ENV:GetStockPrice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<SOAP-ENV:Envelope ...">
  <SOAP-ENV:Body>
    <SOAP-ENV:GetStockPrice>
      <stockPart xsi:type="xsd:string">&lt;Stock&gt;GOOG
        &lt;/Stock&gt;</stockPart>
      <Market>NASDAQ</Market>
      <datePart xsi:type="xsd:dateTime">2007-07-07</datePart>
    </SOAP-ENV:GetStockPrice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

This result is very interesting:

Test 1 used regular values. SoapClient didn't do any encoding. SoapClient passed data type defined in the WSDL document in request.
Test 2 used SoapVal objects. Each of them was created with the correct encoding type that matches the type defined in the WSDL document. SoapClient passed data type defined in the WSDL document in request.
Test 3 used SoapVal objects. But each of them was created with something different. $stock was created with an XML string and XSD_STRING. $market was crated with an XML string and XSD_ANYXML. $date was created with a date string and XSD_DATETIME. SoapClient reacted differently for each of them.
When XSD_STRING is used with a SoapVal object, and the input value is a XML string, SoapClient will encode it to protect XML tags, like replacing < with <.
When XSD_ANYXML is used with a SoapVal object, and the input value is a XML string, SoapClient will keep it as raw XML and use it as the entire parameter element.
When XSD_* encode type is different than the type defined in WSDL document, SoapClient will use the XSD_* type to replace the type defined in WSDL document.