php-doc-en/reference/soap/soapclient.xml
2022-01-03 08:06:35 +01:00

544 lines
17 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.soapclient" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>SoapClient</classname> class</title>
<titleabbrev>SoapClient</titleabbrev>
<partintro>
<!-- {{{ SoapClient intro -->
<section xml:id="soapclient.intro">
&reftitle.intro;
<para>
The SoapClient class provides a client for <link xlink:href="&spec.soap1.1;">SOAP 1.1</link>,
<link xlink:href="&spec.soap1.2;">SOAP 1.2</link> servers.
It can be used in WSDL or non-WSDL mode.
</para>
</section>
<!-- }}} -->
<section xml:id="soapclient.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>SoapClient</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>SoapClient</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.uri">uri</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.style">style</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.use">use</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.location">location</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>bool</type>
<varname linkend="soapclient.props.trace">trace</varname>
<initializer>false</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.compression">compression</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="soapclient.props.sdl">sdl</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="soapclient.props.typemap">typemap</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="soapclient.props.httpsocket">httpsocket</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="soapclient.props.httpurl">httpurl</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-login">_login</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-password">_password</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>bool</type>
<varname linkend="soapclient.props.-use-digest">_use_digest</varname>
<initializer>false</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-digest">_digest</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-proxy-host">_proxy_host</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.-proxy-port">_proxy_port</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-proxy-login">_proxy_login</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-proxy-password">_proxy_password</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>bool</type>
<varname linkend="soapclient.props.-exceptions">_exceptions</varname>
<initializer>true</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-encoding">_encoding</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>array</type><type>null</type></type>
<varname linkend="soapclient.props.-classmap">_classmap</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.-features">_features</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>int</type>
<varname linkend="soapclient.props.-connection-timeout">_connection_timeout</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="soapclient.props.-stream-context">_stream_context</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.-user-agent">_user_agent</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>bool</type>
<varname linkend="soapclient.props.-keep-alive">_keep_alive</varname>
<initializer>true</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.-ssl-method">_ssl_method</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>int</type>
<varname linkend="soapclient.props.-soap-version">_soap_version</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="soapclient.props.-use-proxy">_use_proxy</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>array</type>
<varname linkend="soapclient.props.-cookies">_cookies</varname>
<initializer>[]</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>array</type><type>null</type></type>
<varname linkend="soapclient.props.--default-headers">__default_headers</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>SoapFault</type><type>null</type></type>
<varname linkend="soapclient.props.--soap-fault">__soap_fault</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.--last-request">__last_request</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.--last-response">__last_response</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.--last-request-headers">__last_request_headers</varname>
<initializer>null</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type class="union"><type>string</type><type>null</type></type>
<varname linkend="soapclient.props.--last-response-headers">__last_response_headers</varname>
<initializer>null</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapclient')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapclient')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<section xml:id="soapclient.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="soapclient.props.--default-headers">
<term><varname>__default_headers</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.--last-request">
<term><varname>__last_request</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.--last-request-headers">
<term><varname>__last_request_headers</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.--last-response">
<term><varname>__last_response</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.--last-response-headers">
<term><varname>__last_response_headers</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.--soap-fault">
<term><varname>__soap_fault</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-classmap">
<term><varname>_classmap</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-connection-timeout">
<term><varname>_connection_timeout</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-cookies">
<term><varname>_cookies</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-digest">
<term><varname>_digest</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-encoding">
<term><varname>_encoding</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-exceptions">
<term><varname>_exceptions</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-features">
<term><varname>_features</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-keep-alive">
<term><varname>_keep_alive</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-login">
<term><varname>_login</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-password">
<term><varname>_password</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-proxy-host">
<term><varname>_proxy_host</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-proxy-login">
<term><varname>_proxy_login</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-proxy-password">
<term><varname>_proxy_password</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-proxy-port">
<term><varname>_proxy_port</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-soap-version">
<term><varname>_soap_version</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-ssl-method">
<term><varname>_ssl_method</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-stream-context">
<term><varname>_stream_context</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-use-digest">
<term><varname>_use_digest</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-use-proxy">
<term><varname>_use_proxy</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.-user-agent">
<term><varname>_user_agent</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.compression">
<term><varname>compression</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.httpsocket">
<term><varname>httpsocket</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.httpurl">
<term><varname>httpurl</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.location">
<term><varname>location</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.sdl">
<term><varname>sdl</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.style">
<term><varname>style</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.trace">
<term><varname>trace</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.typemap">
<term><varname>typemap</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.uri">
<term><varname>uri</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.props.use">
<term><varname>use</varname></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</partintro>
&reference.soap.entities.soapclient;
</phpdoc:classref>
<!-- 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
-->