php-doc-en/reference/soap/functions/soap-soapclient-construct.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.soap-soapclient-construct" xmlns="http://docbook.org/ns/docbook">
 <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>
      <note>
       <para>
        During development stage, you may want to disable WSDL caching by the
        mean of the <literal>soap.wsdl_cache_ttl</literal> &php.ini; setting,
        otherwise changes made to the WSDL file will have no effect until
        <literal>soap.wsdl_cache_ttl</literal> is expired. 
       </para>
      </note>
     </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>
      <para>
       The <literal>typemap</literal> option is an array of type mappings.
       Type mapping is an array with keys <literal>type_name</literal>,
       <literal>type_ns</literal> (namespace URI), <literal>from_xml</literal>
       (callback accepting one string parameter) and <literal>to_xml</literal>
       (callback accepting one object parameter).
      </para>
      <para>
      </para>
      <para>
       Other options are <literal>stream_context</literal>,
       <literal>features</literal>, <literal>cache_wsdl</literal> and
       <literal>user_agent</literal>.
      </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
-->