call.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapclient.call" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SoapClient::__call</refname>
  <refpurpose>Calls a SOAP function (deprecated)</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SoapClient">
   <modifier>public</modifier> <type>mixed</type><methodname>SoapClient::__call</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>array</type><parameter>args</parameter></methodparam>
  </methodsynopsis>
  <para>
   Calling this method directly is deprecated. Usually, SOAP functions can be
   called as methods of the <classname>SoapClient</classname> object; in
   situations where this is not possible or additional options are needed, use
   <methodname>SoapClient::__soapCall</methodname>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       The name of the SOAP function to call.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>args</parameter></term>
     <listitem>
      <para>
       An array of the arguments to pass to the function.
       This can be either an ordered or an associative array.
       Note that most SOAP servers require parameter names to be provided, in which case this must be an associative array.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   SOAP functions may return one, or multiple values. If only one value is
   returned by the SOAP function, the return value will be a scalar.
   If multiple values are returned, an associative array of named output
   parameters is returned instead.
  </para>
  <para>
   On error, if the <classname>SoapClient</classname> object was constructed
   with the <literal>exceptions</literal> option set to &false;,
   a <classname>SoapFault</classname> object will be returned.
  </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:"~/.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
-->