1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="soapclient.soapcall" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__soapCall</refname>
<refpurpose>Calls a SOAP function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>SoapClient::__soapCall</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>input_headers</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">output_headers</parameter></methodparam>
</methodsynopsis>
<para>
This is a low level API function that is used to make a SOAP call. Usually,
in WSDL mode, SOAP functions can be called as methods of the
<classname>SoapClient</classname> object. This method is useful in non-WSDL
mode when <literal>soapaction</literal> is unknown, <literal>uri</literal>
differs from the default or when sending and/or receiving SOAP Headers.
</para>
<para>
On error, a call to a SOAP function can cause PHP to throw exceptions or return a
<classname>SoapFault</classname> object if exceptions are disabled.
To check if the function call failed to catch the SoapFault exceptions,
check the result with <function>is_soap_fault</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of the SOAP function to call.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arguments</parameter></term>
<listitem>
<para>
An array of the arguments to pass to the function. This can be either
an ordered or an associative array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array of options to pass to the client.
</para>
<para>
The <literal>location</literal> option is the URL of the remote Web service.
</para>
<para>
The <literal>uri</literal> option is the target namespace of the SOAP service.
</para>
<para>
The <literal>soapaction</literal> option is the action to call.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>input_headers</parameter></term>
<listitem>
<para>
An array of headers to be sent along with the SOAP request.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output_headers</parameter></term>
<listitem>
<para>
If supplied, this array will be filled with the headers from the SOAP response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
SOAP functions may return one, or multiple values. If only one value is returned
by the SOAP function, the return value of <literal>__soapCall</literal> will be
a simple value (e.g. an integer, a string, etc). If multiple values are
returned, <literal>__soapCall</literal> will return
an associative array of named output parameters.
</para>
<para>
On error, if the SoapClient object was constructed with the <literal>trace</literal>
option set to &false;, a SoapFault object will be returned.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapClient::__soapCall</function> example</title>
<programlisting role="php">
<![CDATA[
<?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'));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapParam::SoapParam</methodname></member>
<member><methodname>SoapVar::SoapVar</methodname></member>
<member><methodname>SoapHeader::SoapHeader</methodname></member>
<member><methodname>SoapFault::SoapFault</methodname></member>
<member><function>is_soap_fault</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
