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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrClient" namespace="" name="SolrClient">
<constant name="SEARCH_SERVLET_TYPE" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="UPDATE_SERVLET_TYPE" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="THREADS_SERVLET_TYPE" value="4">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="PING_SERVLET_TYPE" value="8">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="TERMS_SERVLET_TYPE" value="16">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SYSTEM_SERVLET_TYPE" value="32">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="DEFAULT_SEARCH_SERVLET" value="select">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_UPDATE_SERVLET" value="update">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_THREADS_SERVLET" value="admin/threads">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_PING_SERVLET" value="admin/ping">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_TERMS_SERVLET" value="terms">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_SYSTEM_SERVLET" value="admin/system">
<docblock>
<var type="string"/>
</docblock>
</constant>
<method name="addDocument" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a document to the index"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="doc" optional="false" byreference="false" type="object" class="SolrInputDocument"/>
<parameter name="overwrite" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="commitWithin" optional="true" byreference="false" type="int"/>
</method>
<method name="addDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a collection of SolrInputDocument instances to the index"/>
<return type="void"/>
</docblock>
<parameter name="docs" optional="false" byreference="false" type="object" class="array"/>
<parameter name="overwrite" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="commitWithin" optional="true" byreference="false" type="int"/>
</method>
<method name="commit" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Finalizes all add/deletes made to the index"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="softCommit" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="waitSearcher" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="expungeDeletes" optional="true" byreference="false" type="object" class="bool"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructor for the SolrClient object"/>
<return type="void"/>
</docblock>
<parameter name="clientOptions" optional="false" byreference="false" type="object" class="array"/>
</constructor>
<method name="deleteById" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete by Id"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="id" optional="false" byreference="false" type="string"/>
</method>
<method name="deleteByIds" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Deletes by Ids"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="ids" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="deleteByQueries" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes all documents matching any of the queries"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="queries" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="deleteByQuery" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Deletes all documents matching the given query"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="string"/>
</method>
<destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Destructor for SolrClient"/>
<return type="void"/>
</docblock>
</destructor>
<method name="getById" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get Document By Id. Utilizes Solr Realtime Get (RTG)"/>
<return type="SolrQueryResponse"/>
</docblock>
<parameter name="id" optional="false" byreference="false" type="string"/>
</method>
<method name="getByIds" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)"/>
<return type="SolrQueryResponse"/>
</docblock>
<parameter name="ids" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="getDebug" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the debug data for the last connection attempt"/>
<return type="string"/>
</docblock>
</method>
<method name="getOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the client options set internally"/>
<return type="array"/>
</docblock>
</method>
<method name="optimize" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Defragments the index"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="maxSegments" optional="true" byreference="false" type="int"/>
<parameter name="softCommit" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="waitSearcher" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="ping" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if Solr server is still up"/>
<return type="SolrPingResponse"/>
</docblock>
</method>
<method name="query" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sends a query to the server"/>
<return type="SolrQueryResponse"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="object" class="SolrParams"/>
</method>
<method name="request" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sends a raw update request"/>
<return type="SolrUpdateResponse"/>
</docblock>
<parameter name="raw_request" optional="false" byreference="false" type="string"/>
</method>
<method name="rollback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Rollbacks all add/deletes made to the index since the last commit"/>
<return type="SolrUpdateResponse"/>
</docblock>
</method>
<method name="setResponseWriter" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets the response writer used to prepare the response from Solr"/>
<return type="void"/>
</docblock>
<parameter name="responseWriter" optional="false" byreference="false" type="string"/>
</method>
<method name="setServlet" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Changes the specified servlet type to a new value"/>
<return type="bool"/>
</docblock>
<parameter name="type" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="system" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve Solr Server information"/>
<return type="void"/>
</docblock>
</method>
<method name="threads" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks the threads status"/>
<return type="void"/>
</docblock>
</method>
</class>
|
