<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-dispatcher.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yaf-dispatcher.catchexception.php',
    1 => 'Yaf_Dispatcher::catchException',
    2 => '开启/关闭异常捕获',
  ),
  'up' => 
  array (
    0 => 'class.yaf-dispatcher.php',
    1 => 'Yaf_Dispatcher',
  ),
  'prev' => 
  array (
    0 => 'yaf-dispatcher.autorender.php',
    1 => 'Yaf_Dispatcher::autoRender',
  ),
  'next' => 
  array (
    0 => 'yaf-dispatcher.construct.php',
    1 => 'Yaf_Dispatcher::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf_dispatcher/catchexception.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-dispatcher.catchexception" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaf_Dispatcher::catchException</h1>
  <p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Dispatcher::catchException</span> &mdash; <span class="dc-title">开启/关闭异常捕获</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-dispatcher.catchexception-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Dispatcher::catchException</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span> <code class="parameter">$flag</code><span class="initializer"> = null</span></span>): <span class="type"><span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>

  <p class="simpara">
   当
   <a href="yaf.appconfig.php#configuration.yaf.dispatcher.throwexception" class="link">application.dispatcher.throwException</a>
   开启时（也可以通过调用
   <span class="methodname"><a href="yaf-dispatcher.throwexception.php" class="methodname">Yaf_Dispatcher::throwException()</a></span> 来开启），Yaf 会在错误
   发生时抛出异常而不是触发错误。
  </p>
  <p class="simpara">
   如果通过此方法（或通过
   <a href="yaf.appconfig.php#configuration.yaf.dispatcher.catchexception" class="link">application.dispatcher.catchException</a>）
   额外开启了异常捕获，所有未捕获的异常都会被捕获并分发到
   <code class="literal">ErrorController::error</code>（如果已定义）。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-dispatcher.catchexception-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">flag</code></dt>
    <dd>
     <p class="simpara">
      Yaf 是否应该捕获未捕获的异常并将它们分发到
      <code class="literal">ErrorController::error</code>。
     </p>
     <blockquote class="note"><p><strong class="note">注意</strong>: 
      <p class="simpara">
       自 Yaf 2.2.0 起，如果未给出该参数，则会返回当前状态。
      </p>
     </p></blockquote>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yaf-dispatcher.catchexception-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   <span class="classname"><a href="class.yaf-dispatcher.php" class="classname">Yaf_Dispatcher</a></span> 对象自身会在给出 <code class="parameter">flag</code> 时
   返回；未给出该参数时则返回 <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>，指示异常捕获是否开启。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-dispatcher.catchexception-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="function"><strong>Yaf_Dispatcher::catchException()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #FF8000">/* 如果你定义了如下的 ErrorController */
</span><span style="color: #007700">class </span><span style="color: #0000BB">ErrorController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract </span><span style="color: #007700">{
     </span><span style="color: #FF8000">/**
      * 你也可以调用 Yaf_Request_Abstract::getException 来获取
      * 未捕获的异常。
      */
     </span><span style="color: #007700">public function </span><span style="color: #0000BB">errorAction</span><span style="color: #007700">(</span><span style="color: #0000BB">$exception</span><span style="color: #007700">) {
        </span><span style="color: #FF8000">/* 发生了一个错误 */
        </span><span style="color: #007700">switch (</span><span style="color: #0000BB">$exception</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCode</span><span style="color: #007700">()) {
            case </span><span style="color: #0000BB">YAF_ERR_NOTFOUND_MODULE</span><span style="color: #007700">:
            case </span><span style="color: #0000BB">YAF_ERR_NOTFOUND_CONTROLLER</span><span style="color: #007700">:
            case </span><span style="color: #0000BB">YAF_ERR_NOTFOUND_ACTION</span><span style="color: #007700">:
            case </span><span style="color: #0000BB">YAF_ERR_NOTFOUND_VIEW</span><span style="color: #007700">:
                echo </span><span style="color: #0000BB">404</span><span style="color: #007700">, </span><span style="color: #DD0000">":"</span><span style="color: #007700">, </span><span style="color: #0000BB">$exception</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();
                break;
            default :
                </span><span style="color: #0000BB">$message </span><span style="color: #007700">= </span><span style="color: #0000BB">$exception</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();
                echo </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">":"</span><span style="color: #007700">, </span><span style="color: #0000BB">$exception</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();
                break;
        }
     }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>以上示例的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">/* 现在如果发生了一些错误，假设访问了一个不存在的控制器
   （或者你自己抛出一个异常）： */
404:Could not find controller script **/application/controllers/No-exists-controller.php</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-dispatcher.catchexception-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="yaf-dispatcher.throwexception.php" class="methodname" rel="rdfs-seeAlso">Yaf_Dispatcher::throwException()</a> - 开启/关闭异常抛出</span></li>
    <li><span class="methodname"><a href="yaf-dispatcher.seterrorhandler.php" class="methodname" rel="rdfs-seeAlso">Yaf_Dispatcher::setErrorHandler()</a> - 设置错误处理器</span></li>
   </ul>
  </p>
 </div>


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