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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 294374 $ -->
<phpdoc:classref xml:id="class.solrresponse" 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 SolrResponse class</title>
<titleabbrev>SolrResponse</titleabbrev>
<partintro>
<!-- {{{ SolrResponse intro -->
<section xml:id="solrresponse.intro">
&reftitle.intro;
<para>
Represents a response from the Solr server.
</para>
</section>
<!-- }}} -->
<section xml:id="solrresponse.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SolrResponse</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>abstract</modifier>
<classname>SolrResponse</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrresponse.constants.parse-solr-obj">SolrResponse::PARSE_SOLR_OBJ</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrresponse.constants.parse-solr-doc">SolrResponse::PARSE_SOLR_DOC</varname>
<initializer>1</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>protected</modifier>
<type>integer</type>
<varname linkend="solrresponse.props.http-status">http_status</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>integer</type>
<varname linkend="solrresponse.props.parser-mode">parser_mode</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>bool</type>
<varname linkend="solrresponse.props.success">success</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-status-message">http_status_message</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-request-url">http_request_url</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-raw-request-headers">http_raw_request_headers</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-raw-request">http_raw_request</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-raw-response-headers">http_raw_response_headers</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-raw-response">http_raw_response</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>string</type>
<varname linkend="solrresponse.props.http-digested-response">http_digested_response</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrresponse')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ SolrResponse properties -->
<section xml:id="solrresponse.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrresponse.props.http-status">
<term><varname>http_status</varname></term>
<listitem>
<para>The http status of the response.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.parser-mode">
<term><varname>parser_mode</varname></term>
<listitem>
<para>Whether to parse the solr documents as SolrObject or SolrDocument instances.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.success">
<term><varname>success</varname></term>
<listitem>
<para>Was there an error during the request</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-status-message">
<term><varname>http_status_message</varname></term>
<listitem>
<para>Detailed message on http status</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-request-url">
<term><varname>http_request_url</varname></term>
<listitem>
<para>The request URL</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-raw-request-headers">
<term><varname>http_raw_request_headers</varname></term>
<listitem>
<para>A string of raw headers sent during the request.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-raw-request">
<term><varname>http_raw_request</varname></term>
<listitem>
<para>The raw request sent to the server</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-raw-response-headers">
<term><varname>http_raw_response_headers</varname></term>
<listitem>
<para>Response headers from the Solr server.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-raw-response">
<term><varname>http_raw_response</varname></term>
<listitem>
<para>The response message from the server.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.props.http-digested-response">
<term><varname>http_digested_response</varname></term>
<listitem>
<para>The response in PHP serialized format.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SolrResponse constants -->
<section xml:id="solrresponse.constants">
&reftitle.constants;
<section xml:id="solrresponse.constants.types">
<title>SolrResponse Class Constants</title>
<variablelist>
<varlistentry xml:id="solrresponse.constants.parse-solr-obj">
<term><constant>SolrResponse::PARSE_SOLR_OBJ</constant></term>
<listitem>
<para>Documents should be parsed as SolrObject instances</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrresponse.constants.parse-solr-doc">
<term><constant>SolrResponse::PARSE_SOLR_DOC</constant></term>
<listitem>
<para>Documents should be parsed as SolrDocument instances.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrresponse;
</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
-->
|
