didou Tue Feb 24 09:31:49 2004 EDT Added files: /phpdoc/en/reference/soap constants.xml ini.xml reference.xml /phpdoc/en/reference/soap/functions SoapClient-SoapClient.xml SoapServer-SoapServer.xml SoapServer-addFunction.xml is-soap-fault.xml
Modified files: /phpdoc manual.xml.in Log: added some SOAP document, taken from http://cvs.php.net/co.php/php-src/ext/soap/readme.html?login=2&r=1.5 # please be kind and don't touch this, Dmitry and I are still working on this
http://cvs.php.net/diff.php/phpdoc/manual.xml.in?r1=1.163&r2=1.164&ty=u Index: phpdoc/manual.xml.in diff -u phpdoc/manual.xml.in:1.163 phpdoc/manual.xml.in:1.164 --- phpdoc/manual.xml.in:1.163 Tue Feb 24 05:47:08 2004 +++ phpdoc/manual.xml.in Tue Feb 24 09:31:47 2004 @@ -192,6 +192,7 @@ &reference.session.reference; &reference.shmop.reference; &reference.simplexml.reference; + &reference.soap.reference; &reference.sqlite.reference; &reference.swf.reference; &reference.snmp.reference; http://cvs.php.net/co.php/phpdoc/en/reference/soap/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/constants.xml +++ phpdoc/en/reference/soap/constants.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <section id="soap.constants"> &reftitle.constants; &extension.constants; <variablelist> <varlistentry> <term> <constant>SOAP_1_1</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_1_2</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_PERSISTENCE_SESSION</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_PERSISTENCE_REQUEST</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_FUNCTIONS_ALL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ENCODED</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_LITERAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_RPC</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_DOCUMENT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ACTOR_NEXT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ACTOR_NONE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ACTOR_UNLIMATERECEIVER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>UNKNOWN_TYPE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_STRING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_BOOLEAN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_DECIMAL</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_FLOAT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_DOUBLE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_DURATION</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_DATETIME</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_TIME</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_DATE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_GYEARMONTH</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_GYEAR</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_GMONTHDAY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_GDAY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_GMONTH</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_HEXBINARY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_BASE64BINARY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_ANYURI</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_QNAME</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NOTATION</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NORMALIZEDSTRING</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_TOKEN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_LANGUAGE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NMTOKEN</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NAME</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NCNAME</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_ID</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_IDREF</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_IDREFS</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_ENTITY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_ENTITIES</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_INTEGER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NONPOSITIVEINTEGER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NEGATIVEINTEGER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_LONG</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_INT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_SHORT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_BYTE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NONNEGATIVEINTEGER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_UNSIGNEDLONG</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_UNSIGNEDINT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_UNSIGNEDSHORT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_UNSIGNEDBYTE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_POSITIVEINTEGER</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NMTOKENS</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_ANYTYPE</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ENC_OBJECT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SOAP_ENC_ARRAY</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_1999_TIMEINSTANT</constant> (<type>integer</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_NAMESPACE</constant> (<type>string</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>XSD_1999_NAMESPACE</constant> (<type>string</type>) </term> <listitem> <simpara> </simpara> </listitem> </varlistentry> </variablelist> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/ini.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/ini.xml +++ phpdoc/en/reference/soap/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="soap.configuration"> &reftitle.runtime; &extension.runtime; <para> <table> <title>SOAP Configuration Options</title> <tgroup cols="3"> <thead> <row> <entry>Name</entry> <entry>Default</entry> <entry>Changeable</entry> </row> </thead> <tbody> <row> <entry>soap.wsdl_cache_enabled</entry> <entry>"1"</entry> <entry>PHP_INI_ALL</entry> </row> <row> <entry>soap.wsdl_cache_dir</entry> <entry>"/tmp"</entry> <entry>PHP_INI_ALL</entry> </row> <row> <entry>soap.wsdl_cache_ttl</entry> <entry>86400</entry> <entry>PHP_INI_ALL</entry> </row> </tbody> </tgroup> </table> For further details and definition of the PHP_INI_* constants see <function>ini_set</function>. </para> &ini.descriptions.title; <para> <variablelist> <varlistentry id="ini.soap.wsdl_cache_enabled"> <term> <parameter>soap.wsdl_cache_enabled</parameter> <type>boolean</type> </term> <listitem> <para> Enables or disables WSDL caching feature. </para> </listitem> </varlistentry> <varlistentry id="ini.soap.wsdl_cache_dir"> <term> <parameter>soap.wsdl_cache_dir</parameter> <type>string</type> </term> <listitem> <para> Sets the directory name where SOAP extension will put cache files. </para> </listitem> </varlistentry> <varlistentry id="ini.soap.wsdl_cache_ttl"> <term> <parameter>soap.wsdl_cache_ttl</parameter> <type>string</type> </term> <listitem> <para> (time to live) Sets the number of second while cached file will be used instead of original one. </para> </listitem> </varlistentry> </variablelist> </para> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/reference.xml +++ phpdoc/en/reference/soap/reference.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <reference id="ref.soap"> <title>SOAP Functions</title> <titleabbrev>SOAP</titleabbrev> <partintro> <section id="soap.intro"> &reftitle.intro; &warn.experimental; <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.domxml;">GNOME xml library</ulink>. Download and install this library. You will need at least libxml-2.5.4. </para> </section> &reference.soap.ini; <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> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/functions/SoapClient-SoapClient.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/functions/SoapClient-SoapClient.xml +++ phpdoc/en/reference/soap/functions/SoapClient-SoapClient.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <refentry id="function.SoapClient-SoapClient"> <refnamediv> <refname>SoapClient::SoapClient</refname> <refpurpose> SoapClient constructor </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>SoapClient::SoapClient</methodname> <methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This constructor allows creating SoapClient objects in WSDL or nonWSDL mode. The first case requires URI of WSDL file as first parameter and an optional <parameter>options</parameter> array. The second case requires &null; as first parameter and <parameter>options</parameter> array with <literal>location</literal> and <literal>uri</literal> options set. Where location is a URL to request and uri is a target namespace of the SOAP service. </para> <para> <literal>style</literal> and <literal>use</literal> options has effect only on nonWSDL (in WSDL mode they comes from WSDL file). </para> <para> the <literal>soap_version</literal> option allows to work as SOAP 1.1 or SOAP 1.2 client. </para> <para> Some additional options allow using HTTP authentication (<literal>login</literal> and <literal>password</literal>) and HTTP connection through proxy server (<literal>proxy_host</literal>, <literal>proxy_port</literal>, <literal>proxy_login</literal> and <literal>proxy_password</literal>). </para> <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(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)); ?> ]]> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/functions/SoapServer-SoapServer.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/functions/SoapServer-SoapServer.xml +++ phpdoc/en/reference/soap/functions/SoapServer-SoapServer.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <refentry id="function.SoapServer-SoapServer"> <refnamediv> <refname>SoapServer::SoapServer</refname> <refpurpose> SoapServer constructor </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>object</type><methodname>SoapServer::SoapServer</methodname> <methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> This constuctor allows creating SoapServer objects in WSDL or nonWSDL mode. In the first case <parameter>wsdl</parameter> must be set to URI of WSDL file. In the second case, <parameter>wsdl</parameter> must be set to &null; and <literal>uti</literal> option must be set. Additional <parameter>options</parameter> allow setting a default SOAP version (<literal>soap_version</literal>) and actor URI (<literal>actor</literal>). </para> <para> <example> <title>Some examples</title> <programlisting role="php"> <![CDATA[ <?php $server = new SoapServer("some.wsdl"); $server = new SoapServer("some.wsdl", array('soap_version' => SOAP_1_2)); $server = new SoapServer("some.wsdl", array('actor' => "http://example.org/ts-tests/C")); $server = new SoapServer(null, array('uri' => "http://test-uri/")); ?> ]]> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/functions/SoapServer-addFunction.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/functions/SoapServer-addFunction.xml +++ phpdoc/en/reference/soap/functions/SoapServer-addFunction.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <refentry id="function.SoapServer-addFunction"> <refnamediv> <refname>SoapServer::addFunction</refname> <refpurpose> Adds one or several functions those will handle SOAP requests </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>void</type><methodname>SoapServer::addFunction</methodname> <methodparam><type>mixed</type><parameter>functions</parameter></methodparam> </methodsynopsis> <para> Exports one or more functions for remote clients. </para> <para> To export one function pass function name into <parameter>functions</parameter> parameter as string. To export several functions pass an array of function names and to export all functions pass a special constant <constant>SOAP_FUNCTIONS_ALL</constant>. </para> <para> <parameter>functions</parameter> must receive all input arguments in the same order as defined in the WSDL file (They should not receive any output parameters as arguments) and return one or more values. To return several values they must return array with named output parameters. </para> <para> <example> <title>Some examples</title> <programlisting role="php"> <![CDATA[ <?php function func($inputString) { return $inputString; } $server->addFunction("echoString"); function echoTwoStrings($inputString1, $inputString2) { return array("outputString1" => $inputString1, "outputString2" => $inputString2); } $server->addFunction(array("echoString", "echoTwoStrings")); $server->addFunction(SOAP_FUNCTIONS_ALL); ?> ]]> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/soap/functions/is-soap-fault.xml?r=1.1&p=1 Index: phpdoc/en/reference/soap/functions/is-soap-fault.xml +++ phpdoc/en/reference/soap/functions/is-soap-fault.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <refentry id="function.is-soap-fault"> <refnamediv> <refname>is_soap_fault</refname> <refpurpose> checks if SOAP call was failed </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>is_soap_fault</methodname> <methodparam><type>mixed</type><parameter>obj</parameter></methodparam> </methodsynopsis> <para> This function is useful when you like to check if the SOAP call was failed, but don't like to use exceptions. To use it you must create a SoapClient object with exceptions option set to zero or &false;. In this case SOAP method will return a special SoapFault object which encapsulate the fault details (faultcode, faultstring, faultactor and faultdetails). </para> <para> If exceptions is not set then SOAP call will throw an exception on error. <function>is_soap_fault</function> checks if the given parameter is a SoapFault object. </para> <para> <example> <title><function>is_soap_fault</function> example</title> <programlisting role="php"> <![CDATA[ <?php $client = SoapClient("some.wsdl", array('exceptions' => 0)); $result = $client->SomeFunction(...); if (is_soap_fault($result)) { trigger_error("SOAP Fault: (faultcode: {$result->faultcode}, faultstring: {$result->faulstring})", E_ERROR); } ?> ]]> </programlisting> </example> <example> <title>SOAP's standard method for error reporting is exceptions</title> <programlisting role="php"> <![CDATA[ <?php try { $client = SoapClient("some.wsdl"); $result = $client->SomeFunction(...); } catch (SoapFault $fault) { trigger_error("SOAP Fault: (faultcode: {$fault->faultcode}, faultstring: {$fault->faulstring})", E_ERROR); } ?> ]]> </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 -->