set-exception-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 686b6869e2695d96d0f3a2055cfa629a8b3b1ac7 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<refentry xml:id="function.set-exception-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>set_exception_handler</refname>
  <refpurpose>
   ユーザー定義の例外ハンドラ関数を設定する
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>callable</type><type>null</type></type><methodname>set_exception_handler</methodname>
   <methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter></methodparam>
  </methodsynopsis>
  <para>
   例外が try/catch ブロックの中でキャッチされなかった場合の
   デフォルトの例外ハンドラを設定します。
   実行は、<parameter>callback</parameter> がコールされた後に
   停止します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       キャッチされない例外が発生した際にコールされる関数。
       このハンドラ関数は、スローされる
       <classname>Throwable</classname> オブジェクトを引数にとります。
       <classname>Error</classname> と
       <classname>Exception</classname> は、
       どちらも <classname>Throwable</classname>
       インターフェイスを実装しています。
       ハンドラのシグネチャは、次のようになります。
      </para>
      <para>
       <methodsynopsis>
        <type>void</type><methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>Throwable</type><parameter>ex</parameter></methodparam>
       </methodsynopsis>
      </para>
      <para>
        &null; を渡すと、このハンドラをデフォルトの状態に戻せます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   前に定義された例外ハンドラを返します。
   エラー発生時に &null; を返します。
   前にハンドラが定義されていない場合にも &null; が返されます。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>set_exception_handler</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
function exception_handler(Throwable $exception) {
  echo "Uncaught exception: " , $exception->getMessage(), "\n";
}

set_exception_handler('exception_handler');

throw new Exception('Uncaught Exception');
echo "Not Executed\n";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>restore_exception_handler</function></member>
    <member><function>restore_error_handler</function></member>
    <member><function>error_reporting</function></member>
    <member><link linkend="language.exceptions">例外(exceptions)</link></member>
   </simplelist>
  </para>
 </refsect1><!-- }}} -->

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->