php-doc-en/reference/soap/reference.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<!-- Purpose: webservice -->
<!-- Membership: bundled, external -->

<reference id="ref.soap">
 <title>SOAP Functions</title>
 <titleabbrev>SOAP</titleabbrev>

 <partintro>
  <section id="soap.intro">
   &reftitle.intro;
   <para>
    The SOAP extension can be used to write SOAP Servers and Clients. It supports
    subsets of <ulink url="&spec.soap1.1;">SOAP 1.1</ulink>, <ulink
    url="&spec.soap1.2;">SOAP 1.2</ulink> and <ulink
    url="&spec.wsdl;">WSDL 1.1</ulink> specifications.
   </para>
  </section>
   
  <section id="soap.requirements">
   &reftitle.required;
   <para>
    This extension makes use of the <ulink url="&url.libxml;">GNOME xml
    library</ulink>. Download and install this library. You will need at
    least libxml-2.5.4.
   </para>
  </section>

  <section id="soap.installation">
   &reftitle.install;
   <para>
    This extension is only available if PHP was configured with
    <option role="configure">--enable-soap</option>.
   </para>
  </section>

  &reference.soap.ini;

  
  <section id='soap.classes'>
   &reftitle.classes;

   <section id='soap.class.soapclient'>
    <title><classname>SoapClient</classname></title>
    <para></para>
    <section id='soap.class.soapclient.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapclient-construct' /> -
       constructs a new SoapClient object</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='soap.class.soapclient.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapclient-call' /> - Calls a SOAP function (deprecated)</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-dorequest' /> - Performs a SOAP request</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-getfunctions' /> - Returns list of SOAP functions</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-getlastrequest' /> - Returns last SOAP request</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-getlastrequestheaders' /> - Returns last SOAP request headers</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-getlastresponse' /> - Returns last SOAP response</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-getlastresponseheaders' /> - Returns last SOAP response headers</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-gettypes' /> - Returns list of SOAP types</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-setcookie' /> - Sets the
       cookie that will be sent with the SOAP request</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapclient-soapcall' /> - Calls a SOAP function</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section id='soap.class.soapfault'>
    <title><classname>SoapFault</classname></title>
    <para></para>
    <section id='soap.class.soapfault.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapfault-construct' /> - construct a new SoapFault object</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section id='soap.class.soapheader'>
    <title><classname>SoapHeader</classname></title>
    <para>
     <classname>SoapHeader</classname> is a special low-level class for passing 
     or returning SOAP headers. It's just a data holder and it does not have any 
     special methods except its constructor. It can be used in the <xref 
     linkend='function.soap-soapclient-soapcall' /> method to pass a SOAP header or 
     in a SOAP header handler to return the header in a SOAP response.
    </para>
    <section id='soap.class.soapheader.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapheader-construct' /> - construct a new SoapHeader object</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section id='soap.class.soapparam'>
    <title><classname>SoapParam</classname></title>
    <para>
     <classname>SoapParam</classname> is a special low-level class for naming 
     parameters and returning values in <literal>non-WSDL</literal> mode. 
     It's just a data holder and it does not have any special methods except 
     its constructor.
    </para>
    <section id='soap.class.soapparam.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapparam-construct' /> - construct a new SoapParam object</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section id='soap.class.soapserver'>
    <title><classname>SoapServer</classname></title>
    <para></para>
    <section id='soap.class.soapserver.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapserver-construct' /> - construct a new SoapServer object</para>
      </listitem>
     </itemizedlist>
    </section>
    <section id='soap.class.soapserver.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapserver-addfunction' /> - Adds one or several functions those will handle SOAP requests</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapserver-fault' /> - </para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapserver-getfunctions' /> - Returns list of defined functions</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapserver-handle' /> - Handles a SOAP request</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapserver-setclass' /> - Sets class which will handle SOAP requests</para>
      </listitem>
      <listitem>
       <para><xref linkend='function.soap-soapserver-setpersistence' /> - Sets persistence mode of SoapServer</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section id='soap.class.soapvar'>
    <title><classname>SoapVar</classname></title>
    <para>
     <classname>SoapVar</classname> is a special low-level class for encoding
     parameters and returning values in <literal>non-WSDL</literal> mode. It's
     just a data holder and does not have any special methods except the constructor. 
     It's useful when you want to set the type property in SOAP request or response. 
    </para>
    <section id='soap.class.soapvar.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para><xref linkend='function.soap-soapvar-construct' /> - construct a new SoapVar object</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

  </section>
   
   &reference.soap.constants;

  </partintro>
 &reference.soap.functions;
 </reference>
<!-- 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
-->