exception.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.exception" role="exception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>Exception</title>
 <titleabbrev>Exception</titleabbrev>
 
 <partintro>
 
<!-- {{{ Exception intro -->
  <section xml:id="exception.intro">
   &reftitle.intro;
   <para>
    <ooclass><classname>Exception</classname></ooclass> is the base class for
    all user exceptions.
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="exception.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooexception>
     <exceptionname>Exception</exceptionname>
    </ooexception>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Throwable</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>string</type>
     <varname linkend="exception.props.message">message</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>private</modifier>
     <type>string</type>
     <varname linkend="exception.props.string">string</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis xml:id="class.exception..code">
     <modifier>protected</modifier>
     <type>int</type>
     <varname linkend="exception.props.code">code</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>string</type>
     <varname linkend="exception.props.file">file</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>int</type>
     <varname linkend="exception.props.line">line</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>private</modifier>
     <type>array</type>
     <varname linkend="exception.props.trace">trace</varname>
     <initializer>[]</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>private</modifier>
     <type class="union"><type>Throwable</type><type>null</type></type>
     <varname linkend="exception.props.previous">previous</varname>
     <initializer>null</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Exception'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Exception'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 
<!-- }}} -->
 
  </section>
 
<!-- {{{ Exception properties -->
  <section xml:id="exception.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="exception.props.message">
     <term><varname>message</varname></term>
     <listitem>
      <para>The exception message</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.code">
     <term><varname>code</varname></term>
     <listitem>
      <para>The exception code</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.file">
     <term><varname>file</varname></term>
     <listitem>
      <para>The filename where the exception was created</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.line">
     <term><varname>line</varname></term>
     <listitem>
      <para>The line where the exception was created</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.previous">
     <term><varname>previous</varname></term>
     <listitem>
      <para>The previously thrown exception</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.string">
     <term><varname>string</varname></term>
     <listitem>
      <para>The string representation of the stack trace</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="exception.props.trace">
     <term><varname>trace</varname></term>
     <listitem>
      <para>The stack trace as an array</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 
 </partintro>
 
 &language.predefined.exception.construct;
 &language.predefined.exception.getmessage;
 &language.predefined.exception.getprevious;
 &language.predefined.exception.getcode;
 &language.predefined.exception.getfile;
 &language.predefined.exception.getline;
 &language.predefined.exception.gettrace;
 &language.predefined.exception.gettraceasstring;
 &language.predefined.exception.tostring;
 &language.predefined.exception.clone;
 
</reference>
<!-- 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
-->