Skip to content

Commit 8a29bad

Browse files
IMSoPIMSoP
committed
Rewrite SoapClient constructor documentation
This constructor takes a large number of options, most of which were effectively undocumented, leading to a very high volume of User Notes. Some examples and caveats from these notes have been incorporated. The descriptions here are largely based on reverse-engineering the source code (which isn't particularly well commented) and experimenting locally, so may not be 100% accurate, or capture differences between versions.
1 parent e3ac07c commit 8a29bad

File tree

2 files changed

+796
-142
lines changed

2 files changed

+796
-142
lines changed

‎reference/soap/constants.xml‎

Lines changed: 131 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,23 @@
2121
(<type>int</type>)
2222
</entry>
2323
<entry>1</entry>
24-
<entry></entry>
24+
<entry>
25+
Specifies use of SOAP 1.1 when passed as <literal>soap_version</literal>
26+
option to <methodname>SoapServer::__construct</methodname> or
27+
<methodname>SoapClient::__construct</methodname>.
28+
</entry>
2529
</row>
2630
<row xml:id="constant.soap-1-2">
2731
<entry>
2832
<constant>SOAP_1_2</constant>
2933
(<type>int</type>)
3034
</entry>
3135
<entry>2</entry>
32-
<entry></entry>
36+
<entry>
37+
Specifies use of SOAP 1.2 when passed as <literal>soap_version</literal>
38+
option to <methodname>SoapServer::__construct</methodname> or
39+
<methodname>SoapClient::__construct</methodname>.
40+
</entry>
3341
</row>
3442
<row xml:id="constant.soap-persistence-session">
3543
<entry>
@@ -61,31 +69,43 @@
6169
(<type>int</type>)
6270
</entry>
6371
<entry>1</entry>
64-
<entry></entry>
72+
<entry>
73+
Specifies use of SOAP Encoding when passed as <literal>use</literal>
74+
option to <methodname>SoapClient::__construct</methodname>.
75+
</entry>
6576
</row>
6677
<row xml:id="constant.soap-literal">
6778
<entry>
6879
<constant>SOAP_LITERAL</constant>
6980
(<type>int</type>)
7081
</entry>
7182
<entry>2</entry>
72-
<entry></entry>
83+
<entry>
84+
Specifies use of service-specific encoding when passed as <literal>use</literal>
85+
option to <methodname>SoapClient::__construct</methodname>.
86+
</entry>
7387
</row>
7488
<row xml:id="constant.soap-rpc">
7589
<entry>
7690
<constant>SOAP_RPC</constant>
7791
(<type>int</type>)
7892
</entry>
7993
<entry>1</entry>
80-
<entry></entry>
94+
<entry>
95+
Specifies use of RPC-style binding when passed as <literal>style</literal>
96+
option to <methodname>SoapClient::__construct</methodname>.
97+
</entry>
8198
</row>
8299
<row xml:id="constant.soap-document">
83100
<entry>
84101
<constant>SOAP_DOCUMENT</constant>
85102
(<type>int</type>)
86103
</entry>
87104
<entry>2</entry>
88-
<entry></entry>
105+
<entry>
106+
Specifies use of document binding when passed as <literal>style</literal>
107+
option to <methodname>SoapClient::__construct</methodname>.
108+
</entry>
89109
</row>
90110
<row xml:id="constant.soap-actor-next">
91111
<entry>
@@ -117,71 +137,117 @@
117137
(<type>int</type>)
118138
</entry>
119139
<entry>32</entry>
120-
<entry></entry>
140+
<entry>
141+
Specifies use of an "Accept-Encoding" header
142+
when passed as part of
143+
<link linkend="soapclient.construct.options.compression">
144+
the <parameter>compression</parameter> option</link>
145+
to <methodname>SoapClient::__construct</methodname>.
146+
</entry>
121147
</row>
122148
<row xml:id="constant.soap-compression-gzip">
123149
<entry>
124150
<constant>SOAP_COMPRESSION_GZIP</constant>
125151
(<type>int</type>)
126152
</entry>
127153
<entry>0</entry>
128-
<entry></entry>
154+
<entry>
155+
Specifies use of gzip compression
156+
when passed as part of
157+
<link linkend="soapclient.construct.options.compression">
158+
the <parameter>compression</parameter> option</link>
159+
to <methodname>SoapClient::__construct</methodname>.
160+
</entry>
129161
</row>
130162
<row xml:id="constant.soap-compression-deflate">
131163
<entry>
132164
<constant>SOAP_COMPRESSION_DEFLATE</constant>
133165
(<type>int</type>)
134166
</entry>
135167
<entry>16</entry>
136-
<entry></entry>
168+
<entry>
169+
Specifies use of deflate compression
170+
when passed as part of
171+
<link linkend="soapclient.construct.options.compression">
172+
the <parameter>compression</parameter> option</link>
173+
to <methodname>SoapClient::__construct</methodname>.
174+
</entry>
137175
</row>
138176
<row xml:id="constant.soap-authentication-basic">
139177
<entry>
140178
<constant>SOAP_AUTHENTICATION_BASIC</constant>
141179
(<type>int</type>)
142180
</entry>
143181
<entry>0</entry>
144-
<entry></entry>
182+
<entry>
183+
Specifies use of HTTP Basic Authentication when passed as
184+
<literal>authentication</literal> option to
185+
<methodname>SoapClient::__construct</methodname>.
186+
</entry>
145187
</row>
146188
<row xml:id="constant.soap-authentication-digest">
147189
<entry>
148190
<constant>SOAP_AUTHENTICATION_DIGEST</constant>
149191
(<type>int</type>)
150192
</entry>
151193
<entry>1</entry>
152-
<entry></entry>
194+
<entry>
195+
Specifies use of HTTP Digest Authentication when passed as
196+
<literal>authentication</literal> option to
197+
<methodname>SoapClient::__construct</methodname>.
198+
</entry>
153199
</row>
154200
<row xml:id="constant.soap-ssl-method-tls">
155201
<entry>
156202
<constant>SOAP_SSL_METHOD_TLS</constant>
157203
(<type>int</type>)
158204
</entry>
159205
<entry>0</entry>
160-
<entry></entry>
206+
<entry>
207+
Used with the deprecated
208+
<link linkend="soapclient.construct.options.ssl-method">
209+
<parameter>ssl_method</parameter> option</link>
210+
to <methodname>SoapClient::__construct</methodname>.
211+
</entry>
161212
</row>
162213
<row xml:id="constant.soap-ssl-method-sslv2">
163214
<entry>
164215
<constant>SOAP_SSL_METHOD_SSLv2</constant>
165216
(<type>int</type>)
166217
</entry>
167218
<entry>1</entry>
168-
<entry></entry>
219+
<entry>
220+
Used with the deprecated
221+
<link linkend="soapclient.construct.options.ssl-method">
222+
<parameter>ssl_method</parameter> option</link>
223+
to <methodname>SoapClient::__construct</methodname>.
224+
</entry>
169225
</row>
170226
<row xml:id="constant.soap-ssl-method-sslv3">
171227
<entry>
172228
<constant>SOAP_SSL_METHOD_SSLv3</constant>
173229
(<type>int</type>)
174230
</entry>
175231
<entry>2</entry>
176-
<entry></entry>
232+
<entry>
233+
Used with the deprecated
234+
<link linkend="soapclient.construct.options.ssl-method">
235+
<parameter>ssl_method</parameter> option</link>
236+
to <methodname>SoapClient::__construct</methodname>.
237+
</entry>
177238
</row>
178239
<row xml:id="constant.soap-ssl-method-sslv23">
179240
<entry>
180241
<constant>SOAP_SSL_METHOD_SSLv23</constant>
181242
(<type>int</type>)
182243
</entry>
183244
<entry>3</entry>
184-
<entry></entry>
245+
<entry>
246+
Used with the deprecated
247+
<link linkend="soapclient.construct.options.ssl-method">
248+
<parameter>ssl_method</parameter> option</link>
249+
to <methodname>SoapClient::__construct</methodname>.
250+
</entry>
185251
</row>
186252
<row xml:id="constant.unknown-type">
187253
<entry>
@@ -613,55 +679,98 @@
613679
(<type>int</type>)
614680
</entry>
615681
<entry>1</entry>
616-
<entry></entry>
682+
<entry>
683+
Used with the
684+
<link linkend="soapclient.construct.options.features">
685+
<parameter>features</parameter> option</link>
686+
to <methodname>SoapClient::__construct</methodname>.
687+
</entry>
617688
</row>
618689
<row xml:id="constant.soap-wait-one-way-calls">
619690
<entry>
620691
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>
621692
(<type>int</type>)
622693
</entry>
623694
<entry>2</entry>
624-
<entry></entry>
695+
<entry>
696+
Used with the
697+
<link linkend="soapclient.construct.options.features">
698+
<parameter>features</parameter> option</link>
699+
to <methodname>SoapClient::__construct</methodname>.
700+
</entry>
625701
</row>
626702
<row xml:id="constant.soap-use-xsi-array-type">
627703
<entry>
628704
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>
629705
(<type>int</type>)
630706
</entry>
631707
<entry>4</entry>
632-
<entry></entry>
708+
<entry>
709+
Used with the
710+
<link linkend="soapclient.construct.options.features">
711+
<parameter>features</parameter> option</link>
712+
to <methodname>SoapClient::__construct</methodname>.
713+
</entry>
633714
</row>
634715
<row xml:id="constant.wsdl-cache-none">
635716
<entry>
636717
<constant>WSDL_CACHE_NONE</constant>
637718
(<type>int</type>)
638719
</entry>
639720
<entry>0</entry>
640-
<entry></entry>
721+
<entry>
722+
Disables the WSDL cache when used in the
723+
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
724+
configuration option or the
725+
<literal>wsdl_cache</literal> option
726+
to <methodname>SoapClient::__construct</methodname>
727+
and <methodname>SoapServer::__construct</methodname>.
728+
</entry>
641729
</row>
642730
<row xml:id="constant.wsdl-cache-disk">
643731
<entry>
644732
<constant>WSDL_CACHE_DISK</constant>
645733
(<type>int</type>)
646734
</entry>
647735
<entry>1</entry>
648-
<entry></entry>
736+
<entry>
737+
Specifies use of the on-disk WSDL cache only when used in the
738+
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
739+
configuration option or the
740+
<literal>wsdl_cache</literal> option
741+
to <methodname>SoapClient::__construct</methodname>
742+
and <methodname>SoapServer::__construct</methodname>.
743+
</entry>
649744
</row>
650745
<row xml:id="constant.wsdl-cache-memory">
651746
<entry>
652747
<constant>WSDL_CACHE_MEMORY</constant>
653748
(<type>int</type>)
654749
</entry>
655750
<entry>2</entry>
656-
<entry></entry>
751+
<entry>
752+
Specifies use of the in-memory WSDL cache only when used in the
753+
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
754+
configuration option or the
755+
<literal>wsdl_cache</literal> option
756+
to <methodname>SoapClient::__construct</methodname>
757+
and <methodname>SoapServer::__construct</methodname>.
758+
</entry>
657759
</row>
658760
<row xml:id="constant.wsdl-cache-both">
659761
<entry>
660762
<constant>WSDL_CACHE_BOTH</constant>
661763
(<type>int</type>)
662764
</entry>
663765
<entry>3</entry>
664-
<entry></entry>
766+
<entry>
767+
Specifies use of both on-disk and in-memory WSDL caches when used in the
768+
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
769+
configuration option or the
770+
<literal>wsdl_cache</literal> option
771+
to <methodname>SoapClient::__construct</methodname>
772+
and <methodname>SoapServer::__construct</methodname>.
773+
</entry>
665774
</row>
666775
</tbody>
667776
</tgroup>

0 commit comments

Comments
 (0)