File: solrclient.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (237 lines) | stat: -rw-r--r-- 8,583 bytes parent folder | download | duplicates (2)
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.solrclient" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrClient class</title>
 <titleabbrev>SolrClient</titleabbrev>

 <partintro>

<!-- {{{ SolrClient intro -->
  <section xml:id="solrclient.intro">
   &reftitle.intro;
   <para>
    Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient instances is not supported.
   </para>
  </section>
<!-- }}} -->

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

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

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>SolrClient</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.search-servlet-type">SolrClient::SEARCH_SERVLET_TYPE</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.update-servlet-type">SolrClient::UPDATE_SERVLET_TYPE</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.threads-servlet-type">SolrClient::THREADS_SERVLET_TYPE</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.ping-servlet-type">SolrClient::PING_SERVLET_TYPE</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.terms-servlet-type">SolrClient::TERMS_SERVLET_TYPE</varname>
     <initializer>16</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrclient.constants.system-servlet-type">SolrClient::SYSTEM_SERVLET_TYPE</varname>
     <initializer>32</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-search-servlet">SolrClient::DEFAULT_SEARCH_SERVLET</varname>
     <initializer>select</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-update-servlet">SolrClient::DEFAULT_UPDATE_SERVLET</varname>
     <initializer>update</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-threads-servlet">SolrClient::DEFAULT_THREADS_SERVLET</varname>
     <initializer>admin/threads</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-ping-servlet">SolrClient::DEFAULT_PING_SERVLET</varname>
     <initializer>admin/ping</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-terms-servlet">SolrClient::DEFAULT_TERMS_SERVLET</varname>
     <initializer>terms</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="solrclient.constants.default-system-servlet">SolrClient::DEFAULT_SYSTEM_SERVLET</varname>
     <initializer>admin/system</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrclient')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrclient')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrclient')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ SolrClient constants -->
  <section xml:id="solrclient.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="solrclient.constants.search-servlet-type">
     <term><constant>SolrClient::SEARCH_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when updating the search servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.update-servlet-type">
     <term><constant>SolrClient::UPDATE_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when updating the update servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.threads-servlet-type">
     <term><constant>SolrClient::THREADS_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when updating the threads servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.ping-servlet-type">
     <term><constant>SolrClient::PING_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when updating the ping servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.terms-servlet-type">
     <term><constant>SolrClient::TERMS_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when updating the terms servlet.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="solrclient.constants.system-servlet-type">
     <term><constant>SolrClient::SYSTEM_SERVLET_TYPE</constant></term>
     <listitem>
      <para>Used when retrieving system information from the system servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.default-search-servlet">
     <term><constant>SolrClient::DEFAULT_SEARCH_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the search servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.default-update-servlet">
     <term><constant>SolrClient::DEFAULT_UPDATE_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the update servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.default-threads-servlet">
     <term><constant>SolrClient::DEFAULT_THREADS_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the threads servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.default-ping-servlet">
     <term><constant>SolrClient::DEFAULT_PING_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the ping servlet.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrclient.constants.default-terms-servlet">
     <term><constant>SolrClient::DEFAULT_TERMS_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the terms servlet used for the TermsComponent</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="solrclient.constants.default-system-servlet">
     <term><constant>SolrClient::DEFAULT_SYSTEM_SERVLET</constant></term>
     <listitem>
      <para>This is the initial value for the system servlet used to obtain Solr Server information</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.solr.entities.solrclient;

</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
-->