<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.solrexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrException class</title>
 <titleabbrev>SolrException</titleabbrev>

 <partintro>

<!-- {{{ SolrException intro -->
  <section xml:id="solrexception.intro">
   &reftitle.intro;
   <para>
    This is the base class for all exception thrown by the Solr extension classes.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="solrexception.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>SolrException</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>SolrException</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>Exception</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>integer</type>
     <varname linkend="solrexception.props.sourceline">sourceline</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>string</type>
     <varname linkend="solrexception.props.sourcefile">sourcefile</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>string</type>
     <varname linkend="solrexception.props.zif-name">zif_name</varname>
    </fieldsynopsis>

    
    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    
    <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ SolrException properties -->
  <section xml:id="solrexception.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="solrexception.props.message">
     <term><varname>message</varname></term>
     <listitem>
      <para>The error message</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.code">
     <term><varname>code</varname></term>
     <listitem>
      <para>The error code</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.file">
     <term><varname>file</varname></term>
     <listitem>
      <para>The userspace php source file where exception was generated</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.line">
     <term><varname>line</varname></term>
     <listitem>
      <para>The line in userspace php source file where exception was generated</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.sourceline">
     <term><varname>sourceline</varname></term>
     <listitem>
      <para>The line in c-space source file where exception was generated</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.sourcefile">
     <term><varname>sourcefile</varname></term>
     <listitem>
      <para>The c-space source file where exception was generated</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="solrexception.props.zif-name">
     <term><varname>zif_name</varname></term>
     <listitem>
      <para>The c-space function where exception was generated</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.solr.entities.solrexception;

</phpdoc:classref>

<!-- 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:"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
-->