Source of: /manual/en/soapserver.fault.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.soapserver.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'soapserver.fault.php',
1 => 'SoapServer::fault',
),
'up' =>
array (
0 => 'class.soapserver.php',
1 => 'The SoapServer class',
),
'prev' =>
array (
0 => 'soapserver.construct.php',
1 => 'SoapServer::__construct',
),
'next' =>
array (
0 => 'soapserver.getfunctions.php',
1 => 'SoapServer::getFunctions',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="soapserver.fault" class="refentry">
<div class="refnamediv">
<h1 class="refname">SoapServer::fault</h1>
<p class="verinfo">(PHP 5 >= 5.0.1)</p><p class="refpurpose"><span class="refname">SoapServer::fault</span> — <span class="dc-title">Issue SoapServer fault indicating an error</span></p>
</div>
<a name="soapserver.fault.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><b>SoapServer::fault</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$code</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$string</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$actor</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$details</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$name</tt></span>
]]] )</div>
<p class="para rdfs-comment">
Sends a response to the client of the current request indicating an error.
</p>
<blockquote><p><b class="note">Note</b>:
This can only be called when handling a request.
<br />
</p></blockquote>
</div>
<a name="soapserver.fault.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">code</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The error code to return
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">string</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A brief description of the error
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">actor</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A string identifying the actor that caused the fault.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">details</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
More details of the fault
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The name of the fault. This can be used to select a name from a WSDL file.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="soapserver.fault.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<a name="soapserver.fault.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"> <span class="methodname"><a href="soapfault.soapfault.php" class="function" rel="rdfs-seeAlso">SoapFault::SoapFault</a> - SoapFault constructor</span></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
