downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

Our source is open

The syntax highlighted source is automatically generated by PHP from the plaintext script. If you're interested in what's behind the several functions we used, you can always take a look at the source of the following files:

Of course, if you want to see the source of this page, we have it available. You can also browse the SVN repository for this website on svn.php.net.

Source of: /manual/en/soapfault.soapfault.php

<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.soapfault.inc";
$setup = array (
  'home' =>
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' =>
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' =>
  array (
    0 => 'soapfault.soapfault.php',
    1 => 'SoapFault::SoapFault',
  ),
  'up' =>
  array (
    0 => 'class.soapfault.php',
    1 => 'The SoapFault class',
  ),
  'prev' =>
  array (
    0 => 'soapfault.construct.php',
    1 => 'SoapFault::__construct',
  ),
  'next' =>
  array (
    0 => 'soapfault.tostring.php',
    1 => 'SoapFault::__toString',
  ),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);

manual_header();
?>
<div id="soapfault.soapfault" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SoapFault::SoapFault</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.0.1)</p><p class="refpurpose"><span class="refname">SoapFault::SoapFault</span> &mdash; <span class="dc-title">SoapFault constructor</span></p>

 </div>

 <a name="soapfault.soapfault.description"></a><div class="refsect1 description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
    <span class="methodname"><b>SoapFault::SoapFault</b></span>
    ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$faultcode</tt></span>
   , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$faultstring</tt></span>
   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$faultactor</tt></span>
   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$detail</tt></span>
   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$faultname</tt></span>
   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$headerfault</tt></span>
  ]]]] )</div>

  <p class="para rdfs-comment">
   This class is used to send SOAP fault responses from the PHP handler.
   <i><tt class="parameter">faultcode</tt></i>
, <i><tt class="parameter">faultstring</tt></i>
,
   <i><tt class="parameter">faultactor</tt></i>
 and <i><tt class="parameter">details</tt></i>
 are
   standard elements of a SOAP Fault.
  </p>
 </div>


 <a name="soapfault.soapfault.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">faultcode</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       The error code of the <a href="class.soapfault.php" class="classname">SoapFault</a>.
      </p>
     </dd>

   
    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">faultstring</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       The error message of the <a href="class.soapfault.php" class="classname">SoapFault</a>.
      </p>
     </dd>

   
    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">faultactor</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       A string identifying the actor that caused the error.
      </p>
     </dd>

   
    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">detail</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       More details about the cause of the error.
      </p>
     </dd>

   
    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">faultname</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       Can be used to select the proper fault encoding from WSDL.
      </p>
     </dd>

   
    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">headerfault</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       Can be used during SOAP header handling to report an error in the
       response header.
      </p>
     </dd>

   
   </dl>
<p>
  </p>
 </div>


 <a name="soapfault.soapfault.examples"></a><div class="refsect1 examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   </p><div class="example">
    <p><b>Example #1 Some examples</b></p>
    <div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function&nbsp;</span><span style="color: #0000BB">test</span><span style="color: #007700">(</span><span style="color: #0000BB">$x</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;new&nbsp;</span><span style="color: #0000BB">SoapFault</span><span style="color: #007700">(</span><span style="color: #DD0000">"Server"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"Some&nbsp;error&nbsp;message"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$server&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SoapServer</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">,&nbsp;array(</span><span style="color: #DD0000">'uri'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"http://test-uri/"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$server</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFunction</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$server</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">handle</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div><p>
  </p>
  <p class="para">
   It is possible to use PHP exception mechanism to throw SOAP Fault.
  </p>
  <p class="para">
   </p><div class="example">
    <p><b>Example #2 Some examples</b></p>
    <div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function&nbsp;</span><span style="color: #0000BB">test</span><span style="color: #007700">(</span><span style="color: #0000BB">$x</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;throw&nbsp;new&nbsp;</span><span style="color: #0000BB">SoapFault</span><span style="color: #007700">(</span><span style="color: #DD0000">"Server"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"Some&nbsp;error&nbsp;message"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$server&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SoapServer</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">,&nbsp;array(</span><span style="color: #DD0000">'uri'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"http://test-uri/"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$server</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFunction</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$server</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">handle</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div><p>
  </p>
 </div>


 <a name="soapfault.soapfault.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="soapserver.fault.php" class="function" rel="rdfs-seeAlso">SoapServer::fault</a> - Issue SoapServer fault indicating an error</span></li>
    <li class="member"><a href="function.is-soap-fault.php" class="function" rel="rdfs-seeAlso">is_soap_fault()</a> - Checks if a SOAP call has failed</li>
   </ul><p>
  </p>
 </div>


</div><?php manual_footer(); ?>
 
show source | credits | sitemap | contact | advertising | mirror sites