File: solrexception.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (145 lines) | stat: -rw-r--r-- 4,460 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 294374 $ -->

<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">&InheritedMethods;</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:"~/.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
-->