/lisp/php/php-manual-html/class.solrpingresponse.html

https://github.com/cue-taro/emacs-setting-files · HTML · 304 lines · 202 code · 102 blank · 0 comment · 0 complexity · 2d9bd571ba13aaa091062bf8d82333b5 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>The SolrPingResponse class</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="solrupdateresponse.destruct.html">SolrUpdateResponse::__destruct</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="solrpingresponse.construct.html">SolrPingResponse::__construct</a></div>
    11. 

  11.  <div class="up"><a href="book.solr.html">Solr</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="class.solrpingresponse" class="reference">
    14. 

  14. 

  15.  <h1 class="title">The SolrPingResponse class</h1>
    16. 

  16.  
    17. 

  17. 

  18.  <div class="partintro">
    19. 

  19. 

  20. 

  21.   <div class="section" id="solrpingresponse.intro">
    22. 

  22.    <h2 class="title">導入</h2>
    23. 

  23.    <p class="para">
    24. 

  24.     Represents a response to a ping request to the server
    25. 

  25.    </p>
    26. 

  26.   </div>
    27. 

  27. 

  28. 

  29.   <div class="section" id="solrpingresponse.synopsis">
    30. 

  30.    <h2 class="title">クラス概要</h2>
    31. 

  31. 

  32. 

  33.    <div class="classsynopsis">
    34. 

  34.     <div class="ooclass"></div>
    35. 

  35. 

  36. 

  37.     <div class="classsynopsisinfo">
    38. 

  38.      <span class="ooclass">
    39. 

  39.       <span class="modifier">final</span>
    40. 

  40.       <b class="classname">SolrPingResponse</b>
    41. 

  41.      </span>
    42. 

  42.      
    43. 

  43.      <span class="ooclass">
    44. 

  44.       <span class="modifier">extends</span>
    45. 

  45.       <a href="class.solrresponse.html" class="classname">SolrResponse</a>
    46. 

  46.      </span>
    47. 

  47.      {</div>
    48. 

  48. 

  49.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 定数 */</div>
    50. 

  50.     <div class="fieldsynopsis">
    51. 

  51.      <span class="modifier">const</span>
    52. 

  52.      <span class="type">integer</span>
    53. 

  53.       <var class="fieldsynopsis_varname"><a href="class.solrpingresponse.html#solrpingresponse.constants.parse-solr-obj">SolrPingResponse::PARSE_SOLR_OBJ</a></var>
    54. 

  54.      <span class="initializer"> = 0</span>
    55. 

  55.     ;</div>
    56. 

  56. 

  57.     <div class="fieldsynopsis">
    58. 

  58.      <span class="modifier">const</span>
    59. 

  59.      <span class="type">integer</span>
    60. 

  60.       <var class="fieldsynopsis_varname"><a href="class.solrpingresponse.html#solrpingresponse.constants.parse-solr-doc">SolrPingResponse::PARSE_SOLR_DOC</a></var>
    61. 

  61.      <span class="initializer"> = 1</span>
    62. 

  62.     ;</div>
    63. 

  63. 

  64. 

  65.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* プロパティ */</div>
    66. 

  66. 

  67.     
    68. 

  68.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* メソッド */</div>
    69. 

  69.     <div class="methodsynopsis dc-description">
    70. 

  70.     <span class="methodname"><a href="solrpingresponse.construct.html" class="methodname">__construct</a></span>
    71. 

  71.     ( <span class="methodparam">void</span>
    72. 

  72.    )</div>
    73. 

  73. <div class="methodsynopsis dc-description">
    74. 

  74.    <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrpingresponse.destruct.html" class="methodname">__destruct</a></span>
    75. 

  75.     ( <span class="methodparam">void</span>
    76. 

  76.    )</div>
    77. 

  77. <div class="methodsynopsis dc-description">
    78. 

  78.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrpingresponse.getresponse.html" class="methodname">getResponse</a></span>
    79. 

  79.     ( <span class="methodparam">void</span>
    80. 

  80.    )</div>
    81. 

  81. 

  82.     
    83. 

  83.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 継承したメソッド */</div>
    84. 

  84.     <div class="methodsynopsis dc-description">
    85. 

  85.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getdigestedresponse.html" class="methodname">SolrResponse::getDigestedResponse</a></span>
    86. 

  86.     ( <span class="methodparam">void</span>
    87. 

  87.    )</div>
    88. 

  88. <div class="methodsynopsis dc-description">
    89. 

  89.    <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="solrresponse.gethttpstatus.html" class="methodname">SolrResponse::getHttpStatus</a></span>
    90. 

  90.     ( <span class="methodparam">void</span>
    91. 

  91.    )</div>
    92. 

  92. <div class="methodsynopsis dc-description">
    93. 

  93.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.gethttpstatusmessage.html" class="methodname">SolrResponse::getHttpStatusMessage</a></span>
    94. 

  94.     ( <span class="methodparam">void</span>
    95. 

  95.    )</div>
    96. 

  96. <div class="methodsynopsis dc-description">
    97. 

  97.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getrawrequest.html" class="methodname">SolrResponse::getRawRequest</a></span>
    98. 

  98.     ( <span class="methodparam">void</span>
    99. 

  99.    )</div>
    100. 

  100. <div class="methodsynopsis dc-description">
    101. 

  101.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getrawrequestheaders.html" class="methodname">SolrResponse::getRawRequestHeaders</a></span>
    102. 

  102.     ( <span class="methodparam">void</span>
    103. 

  103.    )</div>
    104. 

  104. <div class="methodsynopsis dc-description">
    105. 

  105.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getrawresponse.html" class="methodname">SolrResponse::getRawResponse</a></span>
    106. 

  106.     ( <span class="methodparam">void</span>
    107. 

  107.    )</div>
    108. 

  108. <div class="methodsynopsis dc-description">
    109. 

  109.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getrawresponseheaders.html" class="methodname">SolrResponse::getRawResponseHeaders</a></span>
    110. 

  110.     ( <span class="methodparam">void</span>
    111. 

  111.    )</div>
    112. 

  112. <div class="methodsynopsis dc-description">
    113. 

  113.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrresponse.getrequesturl.html" class="methodname">SolrResponse::getRequestUrl</a></span>
    114. 

  114.     ( <span class="methodparam">void</span>
    115. 

  115.    )</div>
    116. 

  116. <div class="methodsynopsis dc-description">
    117. 

  117.    <span class="modifier">public</span> <span class="type">SolrObject</span> <span class="methodname"><a href="solrresponse.getresponse.html" class="methodname">SolrResponse::getResponse</a></span>
    118. 

  118.     ( <span class="methodparam">void</span>
    119. 

  119.    )</div>
    120. 

  120. <div class="methodsynopsis dc-description">
    121. 

  121.    <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrresponse.setparsemode.html" class="methodname">SolrResponse::setParseMode</a></span>
    122. 

  122.     ([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$parser_mode</tt><span class="initializer"> = 0</span></span>
    123. 

  123.   ] )</div>
    124. 

  124. <div class="methodsynopsis dc-description">
    125. 

  125.    <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrresponse.success.html" class="methodname">SolrResponse::success</a></span>
    126. 

  126.     ( <span class="methodparam">void</span>
    127. 

  127.    )</div>
    128. 

  128. 

  129. 

  130.    }</div>
    131. 

  131. 

  132. 

  133.   </div>
    134. 

  134. 

  135.   
    136. 

  136. 

  137.   <div class="section" id="solrpingresponse.props">
    138. 

  138.    <h2 class="title">プロパティ</h2>
    139. 

  139.    <dl>
    140. 

  140. 

  141.     <dt id="solrpingresponse.props.http-status">
    142. 

  142.      <span class="term"><var class="varname"><var class="varname">http_status</var></var></span>
    143. 

  143.      <dd>
    144. 

  144. 

  145.       <p class="para">The http status of the response.</p>
    146. 

  146.      </dd>
    147. 

  147. 

  148.     </dt>
    149. 

  149. 

  150.     <dt id="solrpingresponse.props.parser-mode">
    151. 

  151.      <span class="term"><var class="varname"><var class="varname">parser_mode</var></var></span>
    152. 

  152.      <dd>
    153. 

  153. 

  154.       <p class="para">Whether to parse the solr documents as SolrObject or SolrDocument instances.</p>
    155. 

  155.      </dd>
    156. 

  156. 

  157.     </dt>
    158. 

  158. 

  159.     <dt id="solrpingresponse.props.success">
    160. 

  160.      <span class="term"><var class="varname"><var class="varname">success</var></var></span>
    161. 

  161.      <dd>
    162. 

  162. 

  163.       <p class="para">Was there an error during the request</p>
    164. 

  164.      </dd>
    165. 

  165. 

  166.     </dt>
    167. 

  167. 

  168.     <dt id="solrpingresponse.props.http-status-message">
    169. 

  169.      <span class="term"><var class="varname"><var class="varname">http_status_message</var></var></span>
    170. 

  170.      <dd>
    171. 

  171. 

  172.       <p class="para">Detailed message on http status</p>
    173. 

  173.      </dd>
    174. 

  174. 

  175.     </dt>
    176. 

  176. 

  177.     <dt id="solrpingresponse.props.http-request-url">
    178. 

  178.      <span class="term"><var class="varname"><var class="varname">http_request_url</var></var></span>
    179. 

  179.      <dd>
    180. 

  180. 

  181.       <p class="para">The request URL</p>
    182. 

  182.      </dd>
    183. 

  183. 

  184.     </dt>
    185. 

  185. 

  186.     <dt id="solrpingresponse.props.http-raw-request-headers">
    187. 

  187.      <span class="term"><var class="varname"><var class="varname">http_raw_request_headers</var></var></span>
    188. 

  188.      <dd>
    189. 

  189. 

  190.       <p class="para">A string of raw headers sent during the request</p>
    191. 

  191.      </dd>
    192. 

  192. 

  193.     </dt>
    194. 

  194. 

  195.     <dt id="solrpingresponse.props.http-raw-request">
    196. 

  196.      <span class="term"><var class="varname"><var class="varname">http_raw_request</var></var></span>
    197. 

  197.      <dd>
    198. 

  198. 

  199.       <p class="para">The raw request sent to the server</p>
    200. 

  200.      </dd>
    201. 

  201. 

  202.     </dt>
    203. 

  203. 

  204.     <dt id="solrpingresponse.props.http-raw-response-headers">
    205. 

  205.      <span class="term"><var class="varname"><var class="varname">http_raw_response_headers</var></var></span>
    206. 

  206.      <dd>
    207. 

  207. 

  208.       <p class="para">Response headers from the Solr server</p>
    209. 

  209.      </dd>
    210. 

  210. 

  211.     </dt>
    212. 

  212. 

  213.     <dt id="solrpingresponse.props.http-raw-response">
    214. 

  214.      <span class="term"><var class="varname"><var class="varname">http_raw_response</var></var></span>
    215. 

  215.      <dd>
    216. 

  216. 

  217.       <p class="para">The response message from the server</p>
    218. 

  218.      </dd>
    219. 

  219. 

  220.     </dt>
    221. 

  221. 

  222.     <dt id="solrpingresponse.props.http-digested-response">
    223. 

  223.      <span class="term"><var class="varname"><var class="varname">http_digested_response</var></var></span>
    224. 

  224.      <dd>
    225. 

  225. 

  226.       <p class="para">The response in PHP serialized format.</p>
    227. 

  227.      </dd>
    228. 

  228. 

  229.     </dt>
    230. 

  230. 

  231.    </dl>
    232. 

  232. 

  233.   </div>
    234. 

  234. 

  235. 

  236.   
    237. 

  237. 

  238.   <div class="section" id="solrpingresponse.constants">
    239. 

  239.    <h2 class="title">定義済み定数</h2>
    240. 

  240.    <div class="section" id="solrpingresponse.constants.types">
    241. 

  241.     <h2 class="title">SolrPingResponse Class Constants</h2>
    242. 

  242.     <dl>
    243. 

  243. 

  244. 

  245.      <dt id="solrpingresponse.constants.parse-solr-obj">
    246. 

  246.       <span class="term"><b><tt>SolrPingResponse::PARSE_SOLR_OBJ</tt></b></span>
    247. 

  247.       <dd>
    248. 

  248. 

  249.        <p class="para">Documents should be parsed as SolrObject instances</p>
    250. 

  250.       </dd>
    251. 

  251. 

  252.      </dt>
    253. 

  253. 

  254. 

  255.      <dt id="solrpingresponse.constants.parse-solr-doc">
    256. 

  256.       <span class="term"><b><tt>SolrPingResponse::PARSE_SOLR_DOC</tt></b></span>
    257. 

  257.       <dd>
    258. 

  258. 

  259.        <p class="para">Documents should be parsed as SolrDocument instances.</p>
    260. 

  260.       </dd>
    261. 

  261. 

  262.      </dt>
    263. 

  263. 

  264. 

  265.     </dl>
    266. 

  266. 

  267.    </div>
    268. 

  268.   </div>
    269. 

  269. 

  270. 

  271. 

  272.  </div>
    273. 

  273. 

  274.  
    275. 

  275. 

  276. 

  277. 

  278. 

  279. 

  280. 

  281. 

  282. 

  283. 

  284. 

  285. 

  286. 

  287. 

  288. 

  289. 

  290. 

  291. 

  292. 

  293. 

  294. 

  295. 

  296. 

  297. <h2>目次</h2><ul class="chunklist chunklist_reference"><li><a href="solrpingresponse.construct.html">SolrPingResponse::__construct</a> — Constructor</li><li><a href="solrpingresponse.destruct.html">SolrPingResponse::__destruct</a> — Destructor</li><li><a href="solrpingresponse.getresponse.html">SolrPingResponse::getResponse</a> — Returns the response from the server</li></ul>
    298. 

  298. </div>
    299. 

  299. <hr /><div class="manualnavbar" style="text-align: center;">
    300. 

  300.  <div class="prev" style="text-align: left; float: left;"><a href="solrupdateresponse.destruct.html">SolrUpdateResponse::__destruct</a></div>
    301. 

  301.  <div class="next" style="text-align: right; float: right;"><a href="solrpingresponse.construct.html">SolrPingResponse::__construct</a></div>
    302. 

  302.  <div class="up"><a href="book.solr.html">Solr</a></div>
    303. 

  303.  <div class="home"><a href="index.html">PHP Manual</a></div>
    304. 

  304. </div></body></html>
    305.