SoapClient->__soapCall()

add a note User Contributed Notes

paulsjv at gmail dot com
11-Jan-2006 11:44


I was working with SOAP for the first time and I had to create a client that sent a date range to a WSDL (Web Services Description Language) to return some information I needed.  I didn't know how to pass the params and there really was no documentation about it.  The main thing you have to make sure to do is when you pass params to a method that is definied by the WSDL that you are calling is that you use the same param name for the key of the array or the object variable as shown below.  Also, if you don't know what the methods/functions that a WSDL has or the params that you need to pass it you can use the __getFunctions() and __getTypes() methods after you declare your new SoapClient.



<?php

// From and to are the two params that the execute function needs

// when called from the WSDL so make you to have them as the

// key to an array like below

$params["From"] = "06/01/2005"; // also can use $params->From = "date";

$params["to"] = "12/31/2005"; // also can use $params->to = "date";



$client = new SoapClient("some.wsdl");



try {

        print($client->execute($params));

} catch (SoapFault $exception) {

        echo $exception;

}

?>

ryan at grunt dot tv
22-Sep-2005 12:38


If you want to pass an xml document node as a function parameter, your need to create a SoapVar object with a text represention of the xml node and the XSD_ANYXML encoding constant. However, this constant is not exported by the extension and is not documented for some unknown reason. 



Therefore, to get this to work you must either register the XSD_ANYXML #define as a PHP constant, or use the integer value of the constant when creating the SoapVar, which is 147.



$soapvar = new SoapVar($xml_text, 147);



$params = array("ItemXml" => $soapvar, "PropertyView" => "blah");

$result = $this->soapclient->__soapCall("SaveItem", array("parameters"=>$params), null, $this->soapheaders);



However, this still doesnt give the correct result. For some reason, the ItemXml parameter node is not wrapped around the associated xml parameter in the soap request, and the following soap is produced (assumming '<item>blah</item>' is used as the $xml_text):



<SOAP-ENV:Envelope xmlns:SOAP-ENV="..." xmlns:ns1="...">

<SOAP-ENV:Header>...</SOAP-ENV:Header>

<SOAP-ENV:Body>

<ns1:SaveItem>

<item>blah</item>

<ns1:PropertyView>blah</ns1:PropertyView>

</ns1:SaveItem>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

DesmondJ
05-May-2005 06:36


Following OrionI's example:



<?php

 $client = new SoapClient("http://server/sumservice.asmx?WSDL");

 $params->a = 2;

 $params->b = 3;

 $objectresult = $client->Sum($params);

 $simpleresult = $objectresult->SumResult;

 print($simpleresult); //produces "-1"

?> 



Please note that the lines: 



"$client->Sum($params);" 



and



"$simpleresult = $objectresult->SumResult;"



are based off of each other. If your web service function is called "Sum", then add "Result" to the end of it to get the results of the call.



EG:



<?php

 $client = new SoapClient("http://server/mathservice.asmx?WSDL");

 $params->a = 2;

 $params->b = 3;

 $objectresult = $client->Minus($params); // note the name of the function is "Minus"

 $simpleresult = $objectresult->MinusResult; // note the name of the result is referenced as "MinusResult"

 print($simpleresult); //produces "5"

?>

OrionI
18-Apr-2005 10:27


Correction on the previously submitted code snippet...the incoming parameter for .NET also has to be in object or array form for it to be correctly converted to the XML form that .NET expects (as already mentioned by Llu?s P?mies). The full example (when using WSDL) should be like this:

<?php

 $client = new SoapClient("http://server/myservice.asmx?WSDL");

 $params->param1 = $value1;

 $params->param2 = $value2;

 $objectresult = $client->MyMethod($params);

 $simpleresult = $objectresult->MyMethodResult;

?>

So if you have a C# function like this:

//sumservice.asmx

...

[WebMethod]

public int Sum(int a, int b)

{

  return a + b;

}

...

The PHP client would be this:

<?php

 $client = new SoapClient("http://server/sumservice.asmx?WSDL");

 $params->a = 2;

 $params->b = 3;

 $objectresult = $client->Sum($params);

 $simpleresult = $objectresult->SumResult;

 print($simpleresult); //produces "5"

?>

OrionI
16-Apr-2005 02:46


When calling over SOAP to a .NET application, you may end up with an object as a result instead of a simple type, even if you're just grabbing a simple type (like a boolean result). Use a property accessor to get the actual result, like this:

<?php

 $client = new SoapClient("http://server/myservice.asmx?WSDL");

 $objectresult = $client->MyMethod($param1, $param2);

 $simpleresult = $objectresult->MyMethodResult;

?>

Note that .NET seems to name the result MethodNameResult for method MethodName.

Llus Pmies
18-Feb-2005 07:19


If your service is a .NET doc/lit, which means the input message has a single part named 'parameters' that is a structure that wraps the parameters.  Your call should look like this:



<?php



$params = array('param_name_1'=>$val_1,'param_name_2'=>$val_2);

$client->call('MethodName', array('parameters' => $params));



?>

add a note

SoapClient->__soapCall()

说明

返回值

范例

参见