Skip to content

Commit f309e78

Browse files
authored
Improve SOAP constructor docs (#4930)
* Move </link> to its own line * Small grammar corrections * Change <example> to <informalexample> Since examples are numbered, and we don't want that here. Since informalexample doesn't accept a title, moped it to a comment to keep the context. * Mark-up WSDL as an acronym Now that the acronym was merged in doc-base.
1 parent fc9a0a8 commit f309e78

File tree

2 files changed

+28
-18
lines changed

2 files changed

+28
-18
lines changed

reference/soap/constants.xml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@
140140
Specifies use of an "Accept-Encoding" header
141141
when passed as part of
142142
<link linkend="soapclient.construct.options.compression">
143-
the <parameter>compression</parameter> option</link>
143+
the <parameter>compression</parameter> option
144+
</link>
144145
to <methodname>SoapClient::__construct</methodname>.
145146
</entry>
146147
</row>
@@ -154,7 +155,8 @@
154155
Specifies use of gzip compression
155156
when passed as part of
156157
<link linkend="soapclient.construct.options.compression">
157-
the <parameter>compression</parameter> option</link>
158+
the <parameter>compression</parameter> option
159+
</link>
158160
to <methodname>SoapClient::__construct</methodname>.
159161
</entry>
160162
</row>
@@ -168,7 +170,8 @@
168170
Specifies use of deflate compression
169171
when passed as part of
170172
<link linkend="soapclient.construct.options.compression">
171-
the <parameter>compression</parameter> option</link>
173+
the <parameter>compression</parameter> option
174+
</link>
172175
to <methodname>SoapClient::__construct</methodname>.
173176
</entry>
174177
</row>
@@ -205,7 +208,8 @@
205208
<entry>
206209
Used with the deprecated
207210
<link linkend="soapclient.construct.options.ssl-method">
208-
<parameter>ssl_method</parameter> option</link>
211+
<parameter>ssl_method</parameter> option
212+
</link>
209213
to <methodname>SoapClient::__construct</methodname>.
210214
</entry>
211215
</row>
@@ -218,7 +222,8 @@
218222
<entry>
219223
Used with the deprecated
220224
<link linkend="soapclient.construct.options.ssl-method">
221-
<parameter>ssl_method</parameter> option</link>
225+
<parameter>ssl_method</parameter> option
226+
</link>
222227
to <methodname>SoapClient::__construct</methodname>.
223228
</entry>
224229
</row>
@@ -231,7 +236,8 @@
231236
<entry>
232237
Used with the deprecated
233238
<link linkend="soapclient.construct.options.ssl-method">
234-
<parameter>ssl_method</parameter> option</link>
239+
<parameter>ssl_method</parameter> option
240+
</link>
235241
to <methodname>SoapClient::__construct</methodname>.
236242
</entry>
237243
</row>
@@ -244,7 +250,8 @@
244250
<entry>
245251
Used with the deprecated
246252
<link linkend="soapclient.construct.options.ssl-method">
247-
<parameter>ssl_method</parameter> option</link>
253+
<parameter>ssl_method</parameter> option
254+
</link>
248255
to <methodname>SoapClient::__construct</methodname>.
249256
</entry>
250257
</row>
@@ -681,7 +688,8 @@
681688
<entry>
682689
Used with the
683690
<link linkend="soapclient.construct.options.features">
684-
<parameter>features</parameter> option</link>
691+
<parameter>features</parameter> option
692+
</link>
685693
to <methodname>SoapClient::__construct</methodname>.
686694
</entry>
687695
</row>
@@ -694,7 +702,8 @@
694702
<entry>
695703
Used with the
696704
<link linkend="soapclient.construct.options.features">
697-
<parameter>features</parameter> option</link>
705+
<parameter>features</parameter> option
706+
</link>
698707
to <methodname>SoapClient::__construct</methodname>.
699708
</entry>
700709
</row>
@@ -707,7 +716,8 @@
707716
<entry>
708717
Used with the
709718
<link linkend="soapclient.construct.options.features">
710-
<parameter>features</parameter> option</link>
719+
<parameter>features</parameter> option
720+
</link>
711721
to <methodname>SoapClient::__construct</methodname>.
712722
</entry>
713723
</row>

reference/soap/soapclient/construct.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<term><parameter>wsdl</parameter></term>
2727
<listitem>
2828
<para>
29-
URI of a WSDL file describing the service, which is used to automatically
29+
URI of a <acronym>WSDL</acronym> file describing the service, which is used to automatically
3030
configure the client. If not provided, the client will operate in non-WSDL
3131
mode.
3232
</para>
@@ -200,7 +200,7 @@
200200
<listitem>
201201
<para>
202202
Path to a client certificate for use with HTTPS authentication.
203-
It must be a <acronym>PEM</acronym> encoded file which contains your certificate
203+
It must be a <acronym>PEM</acronym> encoded file which contains the certificate
204204
and private key.
205205
</para>
206206
<para>
@@ -352,7 +352,7 @@
352352
Used to map types defined in the WSDL to PHP classes.
353353
It should be specified as an associative <type>array</type> with
354354
type names from the WSDL as keys and names of PHP classes as values.
355-
Note that the type names of an element is not necessarily the same as
355+
Note that the type name of an element is not necessarily the same as
356356
the element (tag) name.
357357
</para>
358358
<para>
@@ -590,25 +590,25 @@
590590
or SSL 3, respectively.
591591
Specifying <constant>SOAP_SSL_METHOD_SSLv23</constant> has no effect;
592592
the constant exists only for backwards compatibility.
593-
As of PHP 7.2, specifying <constant>SOAP_SSL_METHOD_TLS</constant>
593+
As of PHP 7.2.0, specifying <constant>SOAP_SSL_METHOD_TLS</constant>
594594
also has no effect; in earlier versions, it forced use of TLS 1.0.
595595
</para>
596596
<para>
597597
Note that SSL versions 2 and 3 are considered insecure, and may not
598598
be supported by the installed OpenSSL library.
599599
</para>
600600
<para>
601-
This option is <emphasis>DEPRECATED</emphasis> as of PHP 8.1.0.
601+
This option is <emphasis role="strong">deprecated</emphasis> as of PHP 8.1.0.
602602
A more flexible alternative, which allows specifying
603603
individual versions of TLS, is to use the
604604
<link linkend="soapclient.construct.options.stream-context">
605605
<parameter>stream_context</parameter></link> option with
606606
the 'crypto_method' context parameter.
607-
<example>
608-
<title>Specifying use of TLS 1.3 only</title>
607+
<informalexample>
609608
<programlisting role="php">
610609
<![CDATA[
611610
<?php
611+
// Specifying use of TLS 1.3 only
612612
$context = stream_context_create([
613613
'ssl' => [
614614
'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT
@@ -617,7 +617,7 @@ $context = stream_context_create([
617617
$client = new SoapClient("some.wsdl", ['context' => $context]);
618618
]]>
619619
</programlisting>
620-
</example>
620+
</informalexample>
621621
</para>
622622
</listitem>
623623
</varlistentry>

0 commit comments

Comments
 (0)