Source of: /manual/en/function.is-soap-fault.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.soap.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.is-soap-fault.php',
1 => 'is_soap_fault',
),
'up' =>
array (
0 => 'ref.soap.php',
1 => 'SOAP Functions',
),
'prev' =>
array (
0 => 'ref.soap.php',
1 => 'SOAP Functions',
),
'next' =>
array (
0 => 'function.use-soap-error-handler.php',
1 => 'use_soap_error_handler',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.is-soap-fault" class="refentry">
<div class="refnamediv">
<h1 class="refname">is_soap_fault</h1>
<p class="verinfo">(Unknown)</p><p class="refpurpose"><span class="refname">is_soap_fault</span> — <span class="dc-title">Checks if a SOAP call has failed</span></p>
</div>
<a name="function.is-soap-fault.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>is_soap_fault</b></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$object</tt></span>
)</div>
<p class="para rdfs-comment">
This function is useful to check if the SOAP call failed, but
without using exceptions. To use it, create a
<a href="class.soapclient.php" class="classname">SoapClient</a> object with the <i>exceptions</i>
option set to zero or <b><tt class="constant">FALSE</tt></b>.
In this case, the SOAP method will return a special
<a href="class.soapfault.php" class="classname">SoapFault</a> object which encapsulates the fault
details (faultcode, faultstring, faultactor and faultdetails).
</p>
<p class="para">
If <i>exceptions</i> is not set then SOAP call will throw
an exception on error.
<b>is_soap_fault()</b> checks if the given
parameter is a <a href="class.soapfault.php" class="classname">SoapFault</a> object.
</p>
</div>
<a name="function.is-soap-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">object</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The object to test.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.is-soap-fault.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This will return <b><tt class="constant">TRUE</tt></b> on error, and <b><tt class="constant">FALSE</tt></b> otherwise.
</p>
</div>
<a name="function.is-soap-fault.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>is_soap_fault()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SoapClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"some.wsdl"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'exceptions' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">SomeFunction</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">is_soap_fault</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"SOAP Fault: (faultcode: </span><span style="color: #007700">{</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">faultcode</span><span style="color: #007700">}</span><span style="color: #DD0000">, faultstring: </span><span style="color: #007700">{</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">faultstring</span><span style="color: #007700">}</span><span style="color: #DD0000">)"</span><span style="color: #007700">, </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p><div class="example">
<p><b>Example #2 SOAP's standard method for error reporting is exceptions</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SoapClient</span><span style="color: #007700">(</span><span style="color: #DD0000">"some.wsdl"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">SomeFunction</span><span style="color: #007700">(</span><span style="color: #FF8000">/* ... */</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">SoapFault $fault</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"SOAP Fault: (faultcode: </span><span style="color: #007700">{</span><span style="color: #0000BB">$fault</span><span style="color: #007700">-></span><span style="color: #0000BB">faultcode</span><span style="color: #007700">}</span><span style="color: #DD0000">, faultstring: </span><span style="color: #007700">{</span><span style="color: #0000BB">$fault</span><span style="color: #007700">-></span><span style="color: #0000BB">faultstring</span><span style="color: #007700">}</span><span style="color: #DD0000">)"</span><span style="color: #007700">, </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.is-soap-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="soapclient.soapclient.php" class="function" rel="rdfs-seeAlso">SoapClient::SoapClient</a> - SoapClient constructor</span></li>
<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(); ?>
