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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrInputDocument" namespace="" name="SolrInputDocument">
<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="addChildDocument" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds a child document for block indexing"/>
<return type="void"/>
</docblock>
<parameter name="child" optional="false" byreference="false" type="object" class="SolrInputDocument"/>
</method>
<method name="addChildDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Adds an array of child documents"/>
<return type="void"/>
</docblock>
<parameter name="docs" optional="false" byreference="false" type="object" class="array"/>
</method>
<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"/>
<parameter name="fieldBoostValue" optional="true" byreference="false" type="object" class="float"/>
</method>
<method name="clear" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Resets the input 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"/>
<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="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"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
</method>
<method name="getBoost" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves the current boost value for the document"/>
<return type="float"/>
</docblock>
</method>
<method name="getChildDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array of child documents (SolrInputDocument)"/>
<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="getFieldBoost" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieves the boost value for a particular field"/>
<return type="float"/>
</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 the document"/>
<return type="int"/>
</docblock>
</method>
<method name="getFieldNames" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an array containing all the fields in the document"/>
<return type="array"/>
</docblock>
</method>
<method name="hasChildDocuments" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns true if the document has any child documents"/>
<return type="bool"/>
</docblock>
</method>
<method name="merge" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Merges one input document into another"/>
<return type="bool"/>
</docblock>
<parameter name="sourceDoc" optional="false" byreference="false" type="object" class="SolrInputDocument"/>
<parameter name="overwrite" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="reset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="This is an alias of SolrInputDocument::clear"/>
<return type="bool"/>
</docblock>
</method>
<method name="setBoost" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets the boost value for this document"/>
<return type="bool"/>
</docblock>
<parameter name="documentBoostValue" optional="false" byreference="false" type="object" class="float"/>
</method>
<method name="setFieldBoost" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets the index-time boost value for a field"/>
<return type="bool"/>
</docblock>
<parameter name="fieldName" optional="false" byreference="false" type="string"/>
<parameter name="fieldBoostValue" optional="false" byreference="false" type="object" class="float"/>
</method>
<method name="sort" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sorts the fields within 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 input document"/>
<return type="array"/>
</docblock>
</method>
</class>
|
