File: SolrResponse.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (150 lines) | stat: -rw-r--r-- 5,605 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrResponse" namespace="" name="SolrResponse">
  <constant name="PARSE_SOLR_OBJ" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="PARSE_SOLR_DOC" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <member name="http_status" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="The http status of the response."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="parser_mode" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="Whether to parse the solr documents as SolrObject or SolrDocument instances."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="success" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="Was there an error during the request"/>
      <var type="bool"/>
    </docblock>
  </member>
  <member name="http_status_message" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="Detailed message on http status"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_request_url" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="The request URL"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_raw_request_headers" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="A string of raw headers sent during the request."/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_raw_request" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="The raw request sent to the server"/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_raw_response_headers" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="Response headers from the Solr server."/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_raw_response" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="The response message from the server."/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="http_digested_response" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact="The response in PHP serialized format."/>
      <var type="string"/>
    </docblock>
  </member>
  <method name="getDigestedResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the XML response as serialized PHP data"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getHttpStatus" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the HTTP status of the response"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getHttpStatusMessage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns more details on the HTTP status"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRawRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the raw request sent to the Solr server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRawRequestHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the raw request headers sent to the Solr server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRawResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the raw response from the server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRawResponseHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the raw response headers from the server"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRequestUrl" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the full URL the request was sent to"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a SolrObject representing the XML response from the server"/>
      <return type="SolrObject"/>
    </docblock>
  </method>
  <method name="setParseMode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the parse mode"/>
      <return type="bool"/>
    </docblock>
    <parameter name="parser_mode" optional="true" byreference="false" type="int"/>
  </method>
  <method name="success" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Was the request a success"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>