downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

SoapClient::SoapClient> <SoapClient::__setSoapHeaders
Last updated: Fri, 13 Nov 2009

view this page in

SoapClient::__soapCall

(PHP 5 >= 5.0.1)

SoapClient::__soapCall — SOAP 関数をコールする

説明

public mixed SoapClient::__soapCall ( string $function_name , array $arguments [, array $options [, mixed $input_headers [, array &$output_headers ]]] )

本メソッドは、SOAP コールを行う低レベル API 関数です。 通常、WSDL モードでは、SOAP 関数を SoapClient のメソッドとして簡単にコールすることができます。 本メソッドは、soapaction が不明な場合や、 uri がデフォルトと異なっていたり、 SOAP ヘッダを送受信したい場合に、非 WSDL モードを使用する際に有用です。

エラーの場合、SOAP 関数のコールは、PHP 例外または、例外が無効な場合に SoapFault オブジェクトが返されます。 この関数コールが失敗したかどうかを調べるには、 SoapFault 例外をキャッチするか、

パラメータ

function_name

コールしたい SOAP 関数の名前。

arguments

関数に渡す引数の配列。これは、数値添字配列あるいは連想配列のどちらの形式でもかまいません。

options

クライアントに渡すオプションの連想配列。

location はリモートウェブサービスの URL です。

uri は SOAP サービスのターゲット名前空間です。

soapaction はコールしたいアクションです。

input_headers

SOAP リクエストで送信するヘッダの配列。

output_headers

指定すると、この配列に SOAP レスポンスのヘッダが書き込まれます。

返り値

SOAP 関数は、一つまたは複数の値を返す可能性があります。 SOAP 関数によって返される値が 1 つだけの場合、__soapCall の返す値は単純な値 (例えば、整数型、文字列など) になります。 複数の値が返される場合、__soapCall は出力パラメータの名前を連想配列として返します。

エラーの場合は、SoapClient オブジェクトの作成時に trace オプションが FALSE となっていれば SoapFault オブジェクトを返します。

例

例1 SoapClient::__soapCall() の例

<?php

$client = new SoapClient("some.wsdl");
$client->SomeFunction($a, $b, $c);

$client->__soapCall("SomeFunction", array($a, $b, $c));
$client->__soapCall("SomeFunction", array($a, $b, $c), NULL,
                    new SoapHeader(), $output_headers);


$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
                                     'uri'      => "http://test-uri/"));
$client->SomeFunction($a, $b, $c);
$client->__soapCall("SomeFunction", array($a, $b, $c));
$client->__soapCall("SomeFunction", array($a, $b, $c),
                    array('soapaction' => 'some_action',
                          'uri'        => 'some_uri'));
?>

参考



SoapClient::SoapClient> <SoapClient::__setSoapHeaders
Last updated: Fri, 13 Nov 2009
 
add a note add a note User Contributed Notes
SoapClient::__soapCall
jarrod at squarecrow dot com
11-Aug-2009 11:37
When dealing with .NET web services, its a good to remember that moving data back and forth between PHP and .NET can be a little cumbersome if you aren't familiar with the object structures of both.

.NET will return everything inside of an object - usually your function name with "Result" tagged onto the end.

Example.

<?php
$client = new soapclient(SOAP_ADDRESS);
$objectresult = $client->GetDataByID(array('PeopleVendorsID'=> 'N21248'));
?>

.... where GetDataByID is my .NET web service function, PeopleVendorsID is name of the parameter I pass it, and "N21248" happens to be the value of the parameter.

.NET was supposed to return an array to $objectresult but instead I found myself with a triple-nested object.

Basically, if you ever find yourself in a situation where you can't seem to access your data, make use of var_dump.

<?php
var_dump($objectresult);
?>

This will print out a very handy array/object structure for you to sift through - invaluable if you're dealing with cryptic results from .NET.
l dot tomov at raz dot bg
02-Aug-2009 10:47
I was trying to call a .net service and it took me quite some hours to get the exact object structure.
I was getting a "SOAP-ERROR: Encoding: object hasn't 'newOrderRequest' property"

This is how I got it working:

<?php
class NewOrderRequestElement
{
    public $merchantID = "1234";
    public $terminalID = "001";
}

class NewOrder
{
    public $newOrderRequest;
}

$no = new NewOrder;
$no->newOrderRequest = new NewOrderRequestElement;

$response = $client->NewOrder($no);

?>

And in order to get the exact class structure, you need to call
$client->__getTypes();

Hope this helps somebody.
jayrajput at gmail dot com
27-Jun-2009 01:56
I see notes from lot of users where they wanted to convert the response to an array.

Problem description as told by one of the user:
--------------------------------------------------------
When a SOAP call returns an array [max_elements=">1"] - you may not actually get an array... (this may be a fault in the wsdl, but it's certainly a potential headache).

foreach($result->field as $field) {
  doSomethingWith($field);
}

With more than 1 <field>, you'll loop through the <field> tags (as expected)...

However, with exactly 1 <field>, you'll instead loop through the child elements of the first <field> (almost certainly *not* what you wanted to happen)...

Solution:
-----------
Use SoapClient features option:

new SoapClient($wsdl, array("features" => SOAP_SINGLE_ELEMENT_ARRAYS);

and then the PHP takes care of converting result to an array.

I have been bitten by this before and never looked into this option ...duh...duh
lesley at casbah dot com dot au
22-Apr-2009 10:55
If you are calling a weblogic service with a certificate and you are getting this error on the soap method call statement:

[EJB:010160]Security Violation: User: '<anonymous>' has insufficient permission to access EJB: type=<ejb>, application=app2_0_52_3, module=appsejb.jar, ejb=AppMethod, method=AppMethod, methodInterface=Remote, signature={java.lang.String}.

then check the wsdl in the soap open call - it must be https.  Supplied with an http wsdl this took some time to figure out.

<?php
    $client = new SoapClient("https://example.com/AppWs/Service?WSDL",
                array('trace'=>true,
                      'exceptions'=>true,
                      'local_cert' => "/var/www/html/app/newcert.pem",
                      'passphrase' => "thepassphrase"));
    $response = $client->__soapCall("MyMethod", array("param1" => $value1));
?>

Thanks to the authors for their comments on enabling openssl and curl by uncommenting extension=php_opensll.dll and extension=php_curl.dll in php.ini.  Also for Olaf's instructions "append the content of the private key file and the certificate file to a single file". I did this using copy command on the DOS prompt:

copy mycert.pem+mykey.pem newcert.pem
Tim Williams
08-Apr-2009 10:55
One little gotcha when passing the parameters where you need to have attributes and a simpletype value:

To get the xml

<foo bar="moo">cheese</foo>

You'd pass in:

<?php
array("foo" => array("_" => "cheese", "bar"=>"moo"));
?>

See that "_" bit? It really wasn't obvious from the documentation.
deWarlock
02-Apr-2009 09:10
The most annoying thing is that you'll get no warning trying to pass object not matching wsdl e.g. if server expects smth like $Object->expName->... and you would pass $Object->otherName the client will send empty request without notifying you.
Also pay attention that names are key sensitive.

In my case I spent hours trying to pass $Post->Lead->... object instead of $Post->lead-> ...
Shto
03-Mar-2009 08:17
One thing to note.

This happened to me and it took a while until I discovered what the problem was.

I was trying to get .NET objects from a provided web service, however it always seemed to return empty objects. It did return the backbone, but nothing within the objects that made up the structure.

Anyhow, it seems that you have to be very precise with the arrays when calling these functions. Par example, do this:

<?php
$obj = $client->__soapCall($SOAPCall, array('parameters'=>$SoapCallParameters));
?>

meaning that you must put an array as the second argument with 'parameters' as the key and the soap call parameters as the value.

Also make sure that the parameter variable, in my case $SoapCallParameters is in the form of what is requested by the webservice.

So, don't just make an array of the form:
<?php

(
   [0] => 'Mary',
   [1] => 1983
)

?>

but if the webservice requests a 'muid' variable as 'Mary' and a 'birthyear' as 1983, then make your array like this:

<?php

(
   [muid] => 'Mary',
   [birthyear] => 1983
)

?>

The above arrays refer to the $SoapCallParameters variable.

Hope this helps somebody, not having to spend too much time figuring out the problems.
dennis at born05 dot nl
05-Feb-2009 02:43
To properly override the __soapCall() method use the following syntax:

<?php
public function __soapCall ($function_name, $arguments, $options = null, $input_headers = null, &$output_headers = null)
{
    // your code goes here..
    return parent::__soapCall($function_name, $arguments, $options, $input_headers, $output_headers);
}
?>

This had me puzzled for a while..
uwe dot trotzek at gmx dot de
06-Jan-2009 06:07
Receiving .NET Datatables in PHP:

<?php
        public function getDataBySQL($strSQL){
            $arrParams = array( 'strSQL' => $strSQL);
           
            try{
                 $arrOptions = array('location' => WBSRV_URI);

                 $this->_sclWebService = new  SoapClient(WBSRV_WSDL_PATH, $arrOptions);

                
                 $dt = $this->_sclWebService
                         ->getTableFromSQL($arrParams)
                         ->getTableFromSQLResult
                         ->any;
                
                 $dt = simplexml_load_string($dt)->NewDataSet;
                
                 return $dt;
             }catch (Exception $e){
                 echo $e->getMessage();
             }
        }
?>
The serialized xml String has to be converted first using the function simplexml_load_string.
Now the complete dataset is represented in $dt
stephan
19-Sep-2008 02:23
When I try to convert result to array I get "Cannot use object of type stdClass as array ..." so I use next:

<?php
function toArray($obj){
    $return=array();
    if (is_array($obj)) {
        $keys=array_keys($obj);
    } elseif (is_object($obj)) {
        $keys=array_keys(get_object_vars($obj));
    } else {return $obj;}
    foreach ($keys as $key) {
        $value=$obj->$key;
        if (is_array($obj)) {
            $return[$key]=toArray($obj[$key]);
        } else {
            $return[$key]=toArray($obj->$key);
        }
    }
    return $return;
}
?>
skunkrecords at gmail . com
31-Aug-2008 02:09
I spent an entire day trying to figure out why I couldn't interface with a .net server! Read  sethm at uoregon dot edu's comment. It will save your life :P
elementation at gmail dot com
31-Jul-2008 04:15
Just as a note, when working with base64'd content, calling a function which returns a base64'd binary value will automagically base64_decode() the value for you, rendering any data unusable if you base64_decode() again.
dess at dessben dot net
30-Apr-2008 05:51
I had several problems with the error "Object reference not set to an instance of an object." with .NET Webservices.
This problem also can be a "non-type" problem.

I can resolved this problem, defining previously the type of the soap functions arguments, with settype() function.

<?php
settype($foo, "string");
?>
sethm at uoregon dot edu
26-Mar-2008 08:05
Trying to connect to a .NET webservice using the PHP SOAP client, we ran into much strangeness.

When using __soapCall do:
$params = array('a'=>$a, 'b'=>$b);
$result = $client->__soapCall('someFunction', array($params));

When using calling the function directly use:
$params = array('a'=>$a, 'b'=>$b);
$result = $client->someFunction($params);

If $params isn't associative, the client doesn't form the call correctly. Calling it other ways lead to having the first parameter dropped or the parameters not being displayed in the request.
Alejandro Cavallo
20-Mar-2008 12:38
I get the same problem reported above by ryan:
"ryan at grunt dot tv
22-Sep-2005 01: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."

When defined variable soapVar I assigned the type XSD_STRING rather than as XSD_ANYXML.
And when calls to the function you must pass the soapVar in an associative array.

For example if the function (called myFunc) expect a parameter called xmlInput you should do something like this:
$soapvar = new SoapVar($query, XSD_STRING);
$result = $client->myFunc(array('xmlInput'=>$soapvar));

This XML fragment are wrapped around xmlImput tags.-
stefan at datax dot biz
24-Oct-2007 11:28
The call to __soapCall returned an object to me either. This is the function which makes my life easier:

function obj2array($obj) {
  $out = array();
  foreach ($obj as $key => $val) {
    switch(true) {
        case is_object($val):
         $out[$key] = obj2array($val);
         break;
      case is_array($val):
         $out[$key] = obj2array($val);
         break;
      default:
        $out[$key] = $val;
    }
  }
  return $out;
}

Usage:
...
$response = $client ->__soapCall("track", array('parameters' => $request));
$response = obj2array($response);

Hope it helps.
stephen at sekka dot co dot uk
01-Aug-2007 11:30
If you are trying to use a .NET web service and every call you make returns the following error,

"Server was unable to process request. --> Object reference not set to an instance of an object."

... then you need to pass Objects into the method rather than the standard variables.

To do this, you need to create mini classes that have properties of the variables you are trying to pass, map them to the types of the WSDL, then pass them into the methods.

Here is an example,

<?php

class Test {
    public $account;
    public $password;
}

$parameters = new Test;
$parameters -> account = $username;
$parameters -> password = $password;

try {
    $client = new SoapClient ("https://www.somewebsite.com/Service.asmx?wsdl", array('classmap' => array('CheckUser' => 'Test')));
    $client -> CheckUser ($parameters);
    echo "Valid Credentials!";
}
catch (Exception $e) {
    echo "Error!<br />";
    echo $e -> getMessage ();
}

?>
andrewa at bigpond dot net dot au
16-Jun-2007 08:14
In response to dumbo's comment on the request not always returning an array:

"more than 1 <field>, you'll loop through the <field> tags (as expected)..."

Here's some quick code to get around it:

<?php
function getArrayFromResponse($data)
{
    if (sizeof($data) < 2) {
        $new = array();
        $new[] = $data;
        return $new;
    }
   
    return $data;
}
?>

Usage:

$result = $soap->__soapCall('DoSomething', array('parameters' => $param))

foreach(getArrayFromResponse($result['ResponseKeyHere']) as $a) {
 // $a will always be an object
}
zeta2ste2000 at yahoo dot it
11-May-2007 05:10
When I have to manage a long number in the header,
 the __soapCall function returns a float number in exponential format.
The returned value can't be sent to the server because it is different
from the original one ( for the floating point values limited precision ).

Example :

// Server sended value : 339051398236687110
$soapclient->__soapCall('beginSession',$parameters, null, null,$header);

echo $header["sessionID"];   // returns 3.3905139823669E+17 or 339051398236687050 ( converted to sting)
                            // and that is different from the original 339051398236687110    

$strNum =  $soapclient->__getLastResponse();

preg_match("([0-9-]{19,20})", $strNum, $args); // Extracts the correct sessionID value as a string
$headers = new SoapHeader( "http://xml.apache.org/axis/session", "sessionID", $args[0]);

$soapclient->__soapCall('nextCall', $parameters, null, $headers);
bliu at computer dot org
16-Apr-2007 10:17
Using  wsdl file automatically generated by the jboss4.2CR1 deployer,
I tried dozens of methods to marshal parameters to a JAXWS endpoint. And the service constantly got null parameters. At last, I found the right way to call is
<?
        $params = array('param1'=>"foo", 'param2'=>"bar");
        $client->__soapCall('yourMethod', array('parameters' => $params));
?>
By this way, the parameters' names and values are correctly enclosed by the method name, and the service gives expected replies.
dumbo
02-Apr-2007 10:02
Note that when a SOAP call returns an array [max_elements=">1"] - you may not actually get an array... (this may be a fault in the wsdl, but it's certainly a potential headache).

foreach($result->field as $field) {
  doSomethingWith($field);
}

With more than 1 <field>, you'll loop through the <field> tags (as expected)...

However, with exactly 1 <field>, you'll instead loop through the child elements of the first <field> (almost certainly *not* what you wanted to happen)...
GoodHater
15-Mar-2007 12:20
I would just like to add to OrionI's example that if the result is an array eg int, int, string, string then those values can be retrieved as follows:

<?php
...
$simpleresult = $objectresult->SumResult;
echo $simpleresult->element name;
temp at mailinator dot com
30-Jan-2007 09:43
The options in the third argument is documented in http://php.net/manual/en/function.soap-soapclient-construct.php
paulsjv at gmail dot com
12-Jan-2006 12: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 01: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 07: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 11: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 03: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 08: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 add a note

SoapClient::SoapClient> <SoapClient::__setSoapHeaders
Last updated: Fri, 13 Nov 2009
 
 
show source | credits | stats | sitemap | contact | advertising | mirror sites