Skip to content

Rewrite SoapClient constructor documentation #537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rewrite SoapClient constructor documentation #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 131 additions & 22 deletions reference/soap/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,23 @@
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Specifies use of SOAP 1.1 when passed as <literal>soap_version</literal>
option to <methodname>SoapServer::__construct</methodname> or
<methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-1-2">
<entry>
<constant>SOAP_1_2</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Specifies use of SOAP 1.2 when passed as <literal>soap_version</literal>
option to <methodname>SoapServer::__construct</methodname> or
<methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-persistence-session">
<entry>
Expand Down Expand Up @@ -61,31 +69,43 @@
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Specifies use of SOAP Encoding when passed as <literal>use</literal>
option to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-literal">
<entry>
<constant>SOAP_LITERAL</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Specifies use of service-specific encoding when passed as <literal>use</literal>
option to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-rpc">
<entry>
<constant>SOAP_RPC</constant>
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Specifies use of RPC-style binding when passed as <literal>style</literal>
option to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-document">
<entry>
<constant>SOAP_DOCUMENT</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Specifies use of document binding when passed as <literal>style</literal>
option to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-actor-next">
<entry>
Expand Down Expand Up @@ -117,71 +137,117 @@
(<type>int</type>)
</entry>
<entry>32</entry>
<entry></entry>
<entry>
Specifies use of an "Accept-Encoding" header
when passed as part of
<link linkend="soapclient.construct.options.compression">
the <parameter>compression</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-compression-gzip">
<entry>
<constant>SOAP_COMPRESSION_GZIP</constant>
(<type>int</type>)
</entry>
<entry>0</entry>
<entry></entry>
<entry>
Specifies use of gzip compression
when passed as part of
<link linkend="soapclient.construct.options.compression">
the <parameter>compression</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-compression-deflate">
<entry>
<constant>SOAP_COMPRESSION_DEFLATE</constant>
(<type>int</type>)
</entry>
<entry>16</entry>
<entry></entry>
<entry>
Specifies use of deflate compression
when passed as part of
<link linkend="soapclient.construct.options.compression">
the <parameter>compression</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-authentication-basic">
<entry>
<constant>SOAP_AUTHENTICATION_BASIC</constant>
(<type>int</type>)
</entry>
<entry>0</entry>
<entry></entry>
<entry>
Specifies use of HTTP Basic Authentication when passed as
<literal>authentication</literal> option to
<methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-authentication-digest">
<entry>
<constant>SOAP_AUTHENTICATION_DIGEST</constant>
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Specifies use of HTTP Digest Authentication when passed as
<literal>authentication</literal> option to
<methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-ssl-method-tls">
<entry>
<constant>SOAP_SSL_METHOD_TLS</constant>
(<type>int</type>)
</entry>
<entry>0</entry>
<entry></entry>
<entry>
Used with the deprecated
<link linkend="soapclient.construct.options.ssl-method">
<parameter>ssl_method</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-ssl-method-sslv2">
<entry>
<constant>SOAP_SSL_METHOD_SSLv2</constant>
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Used with the deprecated
<link linkend="soapclient.construct.options.ssl-method">
<parameter>ssl_method</parameter> option</link>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not happy with the indentation here. I think the </link> should go on an own line, or the two lines should be joined (a bit long, but okay-ish). The same indentation occurs several times below.

to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-ssl-method-sslv3">
<entry>
<constant>SOAP_SSL_METHOD_SSLv3</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Used with the deprecated
<link linkend="soapclient.construct.options.ssl-method">
<parameter>ssl_method</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-ssl-method-sslv23">
<entry>
<constant>SOAP_SSL_METHOD_SSLv23</constant>
(<type>int</type>)
</entry>
<entry>3</entry>
<entry></entry>
<entry>
Used with the deprecated
<link linkend="soapclient.construct.options.ssl-method">
<parameter>ssl_method</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.unknown-type">
<entry>
Expand Down Expand Up @@ -613,55 +679,98 @@
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Used with the
<link linkend="soapclient.construct.options.features">
<parameter>features</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-wait-one-way-calls">
<entry>
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Used with the
<link linkend="soapclient.construct.options.features">
<parameter>features</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.soap-use-xsi-array-type">
<entry>
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>
(<type>int</type>)
</entry>
<entry>4</entry>
<entry></entry>
<entry>
Used with the
<link linkend="soapclient.construct.options.features">
<parameter>features</parameter> option</link>
to <methodname>SoapClient::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.wsdl-cache-none">
<entry>
<constant>WSDL_CACHE_NONE</constant>
(<type>int</type>)
</entry>
<entry>0</entry>
<entry></entry>
<entry>
Disables the WSDL cache when used in the
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
configuration option or the
<literal>wsdl_cache</literal> option
to <methodname>SoapClient::__construct</methodname>
and <methodname>SoapServer::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.wsdl-cache-disk">
<entry>
<constant>WSDL_CACHE_DISK</constant>
(<type>int</type>)
</entry>
<entry>1</entry>
<entry></entry>
<entry>
Specifies use of the on-disk WSDL cache only when used in the
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
configuration option or the
<literal>wsdl_cache</literal> option
to <methodname>SoapClient::__construct</methodname>
and <methodname>SoapServer::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.wsdl-cache-memory">
<entry>
<constant>WSDL_CACHE_MEMORY</constant>
(<type>int</type>)
</entry>
<entry>2</entry>
<entry></entry>
<entry>
Specifies use of the in-memory WSDL cache only when used in the
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
configuration option or the
<literal>wsdl_cache</literal> option
to <methodname>SoapClient::__construct</methodname>
and <methodname>SoapServer::__construct</methodname>.
</entry>
</row>
<row xml:id="constant.wsdl-cache-both">
<entry>
<constant>WSDL_CACHE_BOTH</constant>
(<type>int</type>)
</entry>
<entry>3</entry>
<entry></entry>
<entry>
Specifies use of both on-disk and in-memory WSDL caches when used in the
<link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link>
configuration option or the
<literal>wsdl_cache</literal> option
to <methodname>SoapClient::__construct</methodname>
and <methodname>SoapServer::__construct</methodname>.
</entry>
</row>
</tbody>
</tgroup>
Expand Down
Loading