php-doc-en/reference/soap/functions/use-soap-error-handler.xml
Christoph Michael Becker 40d440e3fd Generate soap methodsynopses based on stubs
Closes GH-287.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352202 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-27 14:46:15 +00:00

78 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.use-soap-error-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>use_soap_error_handler</refname>
<refpurpose>Set whether to use the SOAP error handler</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>use_soap_error_handler</methodname>
<methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
This function sets whether or not to use the SOAP error handler in the SOAP server.
It will return the previous value. If set to &true;, details of errors
in a <classname>SoapServer</classname> application will be sent to the client
as a SOAP fault message.
If &false;, the standard PHP error handler is used.
The default is to send error to the client as SOAP fault message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>enable</parameter></term>
<listitem>
<para>
Set to &true; to send error details to clients.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the original value.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>set_error_handler</function></member>
<member><function>set_exception_handler</function></member>
</simplelist>
</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
-->