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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrDocument" namespace="" name="SolrDocument">
<implements name="ArrayAccess" full="ArrayAccess"/>
<constant name="SORT_DEFAULT" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SORT_ASC" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SORT_DESC" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SORT_FIELD_NAME" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SORT_FIELD_VALUE_COUNT" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="SORT_FIELD_BOOST_VALUE" value="4">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<method name="addField" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a field to the document"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
<parameter name="fieldValue" optional="false" byreference="false" type="string"/>
</method>
<method name="clear" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops all the fields in the document"/>
<return type="bool"/>
</docblock>
</method>
<method name="__clone" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a copy of a SolrDocument object"/>
<return type="void"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructor"/>
<return type="void"/>
</docblock>
</constructor>
<method name="current" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves the current field"/>
<return type="SolrDocumentField"/>
</docblock>
</method>
<method name="deleteField" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes a field from the document"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Destructor"/>
<return type="void"/>
</docblock>
</destructor>
<method name="fieldExists" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if a field exists in the document"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="__get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Access the field as a property"/>
<return type="SolrDocumentField"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="getChildDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array of child documents (SolrDocument)"/>
<return type="array"/>
</docblock>
</method>
<method name="getChildDocumentsCount" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the number of child documents"/>
<return type="int"/>
</docblock>
</method>
<method name="getField" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves a field by name"/>
<return type="SolrDocumentField"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="getFieldCount" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the number of fields in this document"/>
<return type="int"/>
</docblock>
</method>
<method name="getFieldNames" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array of fields names in the document"/>
<return type="array"/>
</docblock>
</method>
<method name="getInputDocument" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a SolrInputDocument equivalent of the object"/>
<return type="SolrInputDocument"/>
</docblock>
</method>
<method name="hasChildDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks whether the document has any child documents"/>
<return type="bool"/>
</docblock>
</method>
<method name="__isset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if a field exists"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="key" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves the current key"/>
<return type="string"/>
</docblock>
</method>
<method name="merge" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Merges source to the current SolrDocument"/>
<return type="bool"/>
</docblock>
<parameter name="sourceDoc" optional="false" byreference="false" type="object" class="SolrDocument"/>
<parameter name="overwrite" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="next" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Moves the internal pointer to the next field"/>
<return type="void"/>
</docblock>
</method>
<method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if a particular field exists"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves a field"/>
<return type="SolrDocumentField"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a field to the document"/>
<return type="void"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
<parameter name="fieldValue" optional="false" byreference="false" type="string"/>
</method>
<method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes a field"/>
<return type="void"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="reset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="This is an alias to SolrDocument::clear()"/>
<return type="bool"/>
</docblock>
</method>
<method name="rewind" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Resets the internal pointer to the beginning"/>
<return type="void"/>
</docblock>
</method>
<method name="serialize" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Used for custom serialization"/>
<return type="string"/>
</docblock>
</method>
<method name="__set" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds another field to the document"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
<parameter name="fieldValue" optional="false" byreference="false" type="string"/>
</method>
<method name="sort" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sorts the fields in the document"/>
<return type="bool"/>
</docblock>
<parameter name="sortOrderBy" optional="false" byreference="false" type="int"/>
<parameter name="sortDirection" optional="true" byreference="false" type="int"/>
</method>
<method name="toArray" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array representation of the document"/>
<return type="array"/>
</docblock>
</method>
<method name="unserialize" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Custom serialization of SolrDocument objects"/>
<return type="void"/>
</docblock>
<parameter name="serialized" optional="false" byreference="false" type="string"/>
</method>
<method name="__unset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Removes a field from the document"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="valid" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks if the current position internally is still valid"/>
<return type="bool"/>
</docblock>
</method>
</class>
|
