Apache_Solr_HttpTransport_Response.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class Apache_Solr_HttpTransport_Response</title>
  7. <link rel="stylesheet" href="../../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="class-name">Class Apache_Solr_HttpTransport_Response</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  19. </div>
  20. <div class="info-box-body">
  21. <!-- ========== Info from phpDoc block ========= -->
  22. <p class="short-description">Represents the required pieces of an HTTP response provided by HTTP transport</p>
  23. <p class="description"><p>implementations and then consumed by the Apache_Solr_Response class which provides decoding</p></p>
  24. <p class="notes">
  25. Located in <a class="field" href="_HttpTransport---Response.php.html">/HttpTransport/Response.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a44">44</a></span>)
  26. </p>
  27. <pre></pre>
  28. </div>
  29. </div>
  30. <a name="sec-method-summary"></a>
  31. <div class="info-box">
  32. <div class="info-box-title">Method Summary</span></div>
  33. <div class="nav-bar">
  34. <a href="#sec-description">Description</a> |
  35. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  36. </div>
  37. <div class="info-box-body">
  38. <div class="method-summary">
  39. <div class="method-definition">
  40. static <span class="method-result">string</span>
  41. <a href="#getDefaultStatusMessage" title="details" class="method-name">getDefaultStatusMessage</a>
  42. (<span class="var-type"></span>&nbsp;<span class="var-name">$statusCode</span>)
  43. </div>
  44. <div class="method-definition">
  45. <span class="method-result">Apache_Solr_HttpTransport_Response</span>
  46. <a href="#__construct" title="details" class="method-name">__construct</a>
  47. (<span class="var-type">integer</span>&nbsp;<span class="var-name">$statusCode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$responseBody</span>)
  48. </div>
  49. <div class="method-definition">
  50. <span class="method-result">string</span>
  51. <a href="#getBody" title="details" class="method-name">getBody</a>
  52. ()
  53. </div>
  54. <div class="method-definition">
  55. <span class="method-result">string</span>
  56. <a href="#getEncoding" title="details" class="method-name">getEncoding</a>
  57. ()
  58. </div>
  59. <div class="method-definition">
  60. <span class="method-result">string</span>
  61. <a href="#getMimeType" title="details" class="method-name">getMimeType</a>
  62. ()
  63. </div>
  64. <div class="method-definition">
  65. <span class="method-result">integer</span>
  66. <a href="#getStatusCode" title="details" class="method-name">getStatusCode</a>
  67. ()
  68. </div>
  69. <div class="method-definition">
  70. <span class="method-result">string</span>
  71. <a href="#getStatusMessage" title="details" class="method-name">getStatusMessage</a>
  72. ()
  73. </div>
  74. </div>
  75. </div>
  76. </div>
  77. <a name="sec-methods"></a>
  78. <div class="info-box">
  79. <div class="info-box-title">Methods</div>
  80. <div class="nav-bar">
  81. <a href="#sec-description">Description</a> |
  82. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  83. </div>
  84. <div class="info-box-body">
  85. <A NAME='method_detail'></A>
  86. <a name="methodgetDefaultStatusMessage" id="getDefaultStatusMessage"><!-- --></a>
  87. <div class="evenrow">
  88. <div class="method-header">
  89. <span class="method-title">static getDefaultStatusMessage</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a112">112</a></span>)
  90. </div>
  91. <!-- ========== Info from phpDoc block ========= -->
  92. <p class="short-description">Get the HTTP status message based on status code</p>
  93. <ul class="tags">
  94. <li><span class="field">access:</span> public</li>
  95. </ul>
  96. <div class="method-signature">
  97. static <span class="method-result">string</span>
  98. <span class="method-name">
  99. getDefaultStatusMessage
  100. </span>
  101. (<span class="var-type"></span>&nbsp;<span class="var-name">$statusCode</span>)
  102. </div>
  103. <ul class="parameters">
  104. <li>
  105. <span class="var-type"></span>
  106. <span class="var-name">$statusCode</span> </li>
  107. </ul>
  108. </div>
  109. <a name="method__construct" id="__construct"><!-- --></a>
  110. <div class="oddrow">
  111. <div class="method-header">
  112. <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a166">166</a></span>)
  113. </div>
  114. <!-- ========== Info from phpDoc block ========= -->
  115. <p class="short-description">Construct a HTTP transport response</p>
  116. <ul class="tags">
  117. <li><span class="field">access:</span> public</li>
  118. </ul>
  119. <div class="method-signature">
  120. <span class="method-result">Apache_Solr_HttpTransport_Response</span>
  121. <span class="method-name">
  122. __construct
  123. </span>
  124. (<span class="var-type">integer</span>&nbsp;<span class="var-name">$statusCode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$responseBody</span>)
  125. </div>
  126. <ul class="parameters">
  127. <li>
  128. <span class="var-type">integer</span>
  129. <span class="var-name">$statusCode</span><span class="var-description">: The HTTP status code</span> </li>
  130. <li>
  131. <span class="var-type">string</span>
  132. <span class="var-name">$contentType</span><span class="var-description">: The VALUE of the Content-Type HTTP header</span> </li>
  133. <li>
  134. <span class="var-type">string</span>
  135. <span class="var-name">$responseBody</span><span class="var-description">: The body of the HTTP response</span> </li>
  136. </ul>
  137. </div>
  138. <a name="methodgetBody" id="getBody"><!-- --></a>
  139. <div class="evenrow">
  140. <div class="method-header">
  141. <span class="method-title">getBody</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a251">251</a></span>)
  142. </div>
  143. <!-- ========== Info from phpDoc block ========= -->
  144. <p class="short-description">Get the raw response body</p>
  145. <ul class="tags">
  146. <li><span class="field">access:</span> public</li>
  147. </ul>
  148. <div class="method-signature">
  149. <span class="method-result">string</span>
  150. <span class="method-name">
  151. getBody
  152. </span>
  153. ()
  154. </div>
  155. </div>
  156. <a name="methodgetEncoding" id="getEncoding"><!-- --></a>
  157. <div class="oddrow">
  158. <div class="method-header">
  159. <span class="method-title">getEncoding</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a241">241</a></span>)
  160. </div>
  161. <!-- ========== Info from phpDoc block ========= -->
  162. <p class="short-description">Get the charset encoding of the response body.</p>
  163. <ul class="tags">
  164. <li><span class="field">access:</span> public</li>
  165. </ul>
  166. <div class="method-signature">
  167. <span class="method-result">string</span>
  168. <span class="method-name">
  169. getEncoding
  170. </span>
  171. ()
  172. </div>
  173. </div>
  174. <a name="methodgetMimeType" id="getMimeType"><!-- --></a>
  175. <div class="evenrow">
  176. <div class="method-header">
  177. <span class="method-title">getMimeType</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a231">231</a></span>)
  178. </div>
  179. <!-- ========== Info from phpDoc block ========= -->
  180. <p class="short-description">Get the mimetype of the response body</p>
  181. <ul class="tags">
  182. <li><span class="field">access:</span> public</li>
  183. </ul>
  184. <div class="method-signature">
  185. <span class="method-result">string</span>
  186. <span class="method-name">
  187. getMimeType
  188. </span>
  189. ()
  190. </div>
  191. </div>
  192. <a name="methodgetStatusCode" id="getStatusCode"><!-- --></a>
  193. <div class="oddrow">
  194. <div class="method-header">
  195. <span class="method-title">getStatusCode</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a211">211</a></span>)
  196. </div>
  197. <!-- ========== Info from phpDoc block ========= -->
  198. <p class="short-description">Get the status code of the response</p>
  199. <ul class="tags">
  200. <li><span class="field">access:</span> public</li>
  201. </ul>
  202. <div class="method-signature">
  203. <span class="method-result">integer</span>
  204. <span class="method-name">
  205. getStatusCode
  206. </span>
  207. ()
  208. </div>
  209. </div>
  210. <a name="methodgetStatusMessage" id="getStatusMessage"><!-- --></a>
  211. <div class="evenrow">
  212. <div class="method-header">
  213. <span class="method-title">getStatusMessage</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportResponse.php.html#a221">221</a></span>)
  214. </div>
  215. <!-- ========== Info from phpDoc block ========= -->
  216. <p class="short-description">Get the status message of the response</p>
  217. <ul class="tags">
  218. <li><span class="field">access:</span> public</li>
  219. </ul>
  220. <div class="method-signature">
  221. <span class="method-result">string</span>
  222. <span class="method-name">
  223. getStatusMessage
  224. </span>
  225. ()
  226. </div>
  227. </div>
  228. </div>
  229. </div>
  230. <p class="notes" id="credit">
  231. Documentation generated on Wed, 04 May 2011 11:01:16 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  232. </p>
  233. </div></body>
  234. </html>