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 175 176 177 178 179 180
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.soap-soapclient-construct">
<refnamediv>
<refname>SoapClient->__construct()</refname>
<refpurpose>
SoapClient constructor
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<para>
This constructor creates <classname>SoapClient</classname> objects
in <literal>WSDL</literal> or <literal>non-WSDL</literal> mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
URI of the <literal>WSDL</literal> file or &null; if working in
<literal>non-WSDL</literal> mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An array of options. If working in WSDL mode, this parameter is optional.
If working in non-WSDL mode, you must set the <literal>location</literal>
and <literal>uri</literal> options, where <literal>location</literal> is
the URL to request and <literal>uri</literal> is the target namespace of the
SOAP service.
</para>
<para>
The <literal>style</literal> and <literal>use</literal> options only work in
non-WSDL mode. In WSDL mode, they come from the WSDL file.
</para>
<para>
The <literal>soap_version</literal> option specifies whether to use SOAP
1.1, or SOAP 1.2 client.
</para>
<para>
For HTTP authentication, you may use the <literal>login</literal> and
<literal>password</literal> options. For making an HTTP connection through
a proxy server, use the options <literal>proxy_host</literal>,
<literal>proxy_port</literal>, <literal>proxy_login</literal>
and <literal>proxy_password</literal>.
For HTTPS client certificate authentication use
<literal>local_cert</literal> and <literal>passphrase</literal> options.
</para>
<para>
The <literal>compression</literal> option allows to use compression
of HTTP SOAP requests and responses.
</para>
<para>
The <literal>encoding</literal> option defines internal character
encoding. This option does not change the encoding of SOAP requests (it is
always utf-8), but converts strings into it.
</para>
<para>
The <literal>classmap</literal> option can be used to map some WSDL
types to PHP classes. This option must be an array with WSDL types
as keys and names of PHP classes as values.
</para>
<para>
Setting the boolean <literal>trace</literal> option enables use of the
methods <link linkend="function.soap-soapclient-getlastrequest">
SoapClient->__getLastRequest</link>,
<link linkend="function.soap-soapclient-getlastrequestheaders">
SoapClient->__getLastRequestHeaders</link>,
<link linkend="function.soap-soapclient-getlastresponse">
SoapClient->__getLastResponse</link> and
<link linkend="function.soap-soapclient-getlastresponseheaders">
SoapClient->__getLastResponseHeaders</link>.
</para>
<para>
The <literal>exceptions</literal> option is a boolean value defining whether
soap errors throw exceptions of type <link linkend="function.soap-soapfault-construct">
SoapFault</link>.
</para>
<para>
The <literal>connection_timeout</literal> option defines a timeout in seconds
for the connection to the SOAP service. This option does not define a timeout
for services with slow responses. To limit the time to wait for calls to finish the
<link linkend="ini.default-socket-timeout">default_socket_timeout</link> setting
is available.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient examples</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient("some.wsdl");
$client = new SoapClient("some.wsdl", array('soap_version' => SOAP_1_2));
$client = new SoapClient("some.wsdl", array('login' => "some_name",
'password' => "some_password"));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080,
'proxy_login' => "some_name",
'proxy_password' => "some_password"));
$client = new SoapClient("some.wsdl", array('local_cert' => "cert_key.pem"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/",
'style' => SOAP_DOCUMENT,
'use' => SOAP_LITERAL));
$client = new SoapClient("some.wsdl",
array('compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP));
$server = new SoapClient("some.wsdl", array('encoding'=>'ISO-8859-1'));
class MyBook {
public $title;
public $author;
}
$server = new SoapClient("books.wsdl", array('classmap' => array('book' => "MyBook")));
?>
]]>
</programlisting>
</example>
</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:"../../../../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
-->
|