<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.is-soap-fault.php',
    1 => 'is_soap_fault',
    2 => 'SOAP コールが失敗したかどうかを調べる',
  ),
  'up' => 
  array (
    0 => 'ref.soap.php',
    1 => 'SOAP 関数',
  ),
  'prev' => 
  array (
    0 => 'ref.soap.php',
    1 => 'SOAP 関数',
  ),
  'next' => 
  array (
    0 => 'function.use-soap-error-handler.php',
    1 => 'use_soap_error_handler',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/soap/functions/is-soap-fault.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.is-soap-fault" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">is_soap_fault</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">is_soap_fault</span> &mdash; <span class="dc-title">SOAP コールが失敗したかどうかを調べる</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.is-soap-fault-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>is_soap_fault</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$object</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   この関数は、SOAP コールが失敗したかどうかを調べたいが、例外を使用したくない
   場合に有用です。
   この関数を使用するには、オプション <code class="literal">exceptions</code> に
   ゼロまたは <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を指定して <span class="classname"><a href="class.soapclient.php" class="classname">SoapClient</a></span>
   オブジェクトを作成する必要があります。
   この場合、SOAP メソッドは、特別な <span class="classname"><a href="class.soapfault.php" class="classname">SoapFault</a></span>
   オブジェクトを返します。
   このオブジェクトには、フォルトの詳細 (faultcode,
   faultstring, faultactor および faultdetails) が含まれています。
  </p>
  <p class="para">
   <code class="literal">exceptions</code> が設定されていない場合、
   SOAPコールは、エラー時に例外をスローします。
   <span class="function"><strong>is_soap_fault()</strong></span> は指定したパラメータ
   <span class="classname"><a href="class.soapfault.php" class="classname">SoapFault</a></span> オブジェクトであるかどうかを調べます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.is-soap-fault-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">object</code></dt>
     <dd>
      <p class="para">
       検査するオブジェクト
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.is-soap-fault-returnvalues">
  <h3 class="title">戻り値</h3>
  
  <p class="para">
   エラー時に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>、それ以外の場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.is-soap-fault-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>is_soap_fault()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">=&gt; </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">-&gt;</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">-&gt;</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">-&gt;</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">?&gt;</span></span></code></div>
    </div>

   </div>
   <div class="example" id="example-2">
    <p><strong>例2 SOAP の標準的なエラーレポートメソッドは例外となる</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">-&gt;</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">-&gt;</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">-&gt;</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">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.is-soap-fault-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="soapclient.construct.php" class="methodname" rel="rdfs-seeAlso">SoapClient::__construct()</a> - SoapClient のコンストラクタ</span></li>
    <li><span class="methodname"><a href="soapfault.construct.php" class="methodname" rel="rdfs-seeAlso">SoapFault::__construct()</a> - SoapFault コンストラクタ</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>