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

https://github.com/cue-taro/emacs-setting-files · HTML · 533 lines · 260 code · 273 blank · 0 comment · 0 complexity · 0b771ec503e630f4b45b6602cbedb37c MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  5. <title>The SolrDocument class</title>
  6. </head>
  7. <body><div class="manualnavbar" style="text-align: center;">
  8. <div class="prev" style="text-align: left; float: left;"><a href="solrinputdocument.toarray.html">SolrInputDocument::toArray</a></div>
  9. <div class="next" style="text-align: right; float: right;"><a href="solrdocument.addfield.html">SolrDocument::addField</a></div>
  10. <div class="up"><a href="book.solr.html">Solr</a></div>
  11. <div class="home"><a href="index.html">PHP Manual</a></div>
  12. </div><hr /><div id="class.solrdocument" class="reference">
  13. <h1 class="title">The SolrDocument class</h1>
  14. <div class="partintro">
  15. <div class="section" id="solrdocument.intro">
  16. <h2 class="title">導入</h2>
  17. <p class="para">
  18. Represents a Solr document retrieved from a query response.
  19. </p>
  20. </div>
  21. <div class="section" id="solrdocument.synopsis">
  22. <h2 class="title">クラス概要</h2>
  23. <div class="classsynopsis">
  24. <div class="ooclass"></div>
  25. <div class="classsynopsisinfo">
  26. <span class="ooclass">
  27. <span class="modifier">final</span>
  28. <b class="classname">SolrDocument</b>
  29. </span>
  30. <span class="oointerface">implements
  31. <span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
  32. </span>
  33. <span class="oointerface">,
  34. <span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span>
  35. </span>
  36. <span class="oointerface">,
  37. <span class="interfacename"><a href="class.traversable.html" class="interfacename">Traversable</a></span>
  38. </span>
  39. <span class="oointerface">,
  40. <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
  41. </span>
  42. {</div>
  43. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 定数 */</div>
  44. <div class="fieldsynopsis">
  45. <span class="modifier">const</span>
  46. <span class="type">integer</span>
  47. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-default">SolrDocument::SORT_DEFAULT</a></var>
  48. <span class="initializer"> = 1</span>
  49. ;</div>
  50. <div class="fieldsynopsis">
  51. <span class="modifier">const</span>
  52. <span class="type">integer</span>
  53. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-asc">SolrDocument::SORT_ASC</a></var>
  54. <span class="initializer"> = 1</span>
  55. ;</div>
  56. <div class="fieldsynopsis">
  57. <span class="modifier">const</span>
  58. <span class="type">integer</span>
  59. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-desc">SolrDocument::SORT_DESC</a></var>
  60. <span class="initializer"> = 2</span>
  61. ;</div>
  62. <div class="fieldsynopsis">
  63. <span class="modifier">const</span>
  64. <span class="type">integer</span>
  65. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-field-name">SolrDocument::SORT_FIELD_NAME</a></var>
  66. <span class="initializer"> = 1</span>
  67. ;</div>
  68. <div class="fieldsynopsis">
  69. <span class="modifier">const</span>
  70. <span class="type">integer</span>
  71. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-field-value-count">SolrDocument::SORT_FIELD_VALUE_COUNT</a></var>
  72. <span class="initializer"> = 2</span>
  73. ;</div>
  74. <div class="fieldsynopsis">
  75. <span class="modifier">const</span>
  76. <span class="type">integer</span>
  77. <var class="fieldsynopsis_varname"><a href="class.solrdocument.html#solrdocument.constants.sort-field-boost-value">SolrDocument::SORT_FIELD_BOOST_VALUE</a></var>
  78. <span class="initializer"> = 4</span>
  79. ;</div>
  80. <div class="classsynopsisinfo classsynopsisinfo_comment">/* メソッド */</div>
  81. <div class="methodsynopsis dc-description">
  82. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.addfield.html" class="methodname">addField</a></span>
  83. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  84. , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldValue</tt></span>
  85. )</div>
  86. <div class="methodsynopsis dc-description">
  87. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.clear.html" class="methodname">clear</a></span>
  88. ( <span class="methodparam">void</span>
  89. )</div>
  90. <div class="methodsynopsis dc-description">
  91. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.clone.html" class="methodname">__clone</a></span>
  92. ( <span class="methodparam">void</span>
  93. )</div>
  94. <div class="methodsynopsis dc-description">
  95. <span class="methodname"><a href="solrdocument.construct.html" class="methodname">__construct</a></span>
  96. ( <span class="methodparam">void</span>
  97. )</div>
  98. <div class="methodsynopsis dc-description">
  99. <span class="modifier">public</span> <span class="type">SolrDocumentField</span> <span class="methodname"><a href="solrdocument.current.html" class="methodname">current</a></span>
  100. ( <span class="methodparam">void</span>
  101. )</div>
  102. <div class="methodsynopsis dc-description">
  103. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.deletefield.html" class="methodname">deleteField</a></span>
  104. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  105. )</div>
  106. <div class="methodsynopsis dc-description">
  107. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.destruct.html" class="methodname">__destruct</a></span>
  108. ( <span class="methodparam">void</span>
  109. )</div>
  110. <div class="methodsynopsis dc-description">
  111. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.fieldexists.html" class="methodname">fieldExists</a></span>
  112. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  113. )</div>
  114. <div class="methodsynopsis dc-description">
  115. <span class="modifier">public</span> <span class="type">SolrDocumentField</span> <span class="methodname"><a href="solrdocument.get.html" class="methodname">__get</a></span>
  116. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  117. )</div>
  118. <div class="methodsynopsis dc-description">
  119. <span class="modifier">public</span> <span class="type">SolrDocumentField</span> <span class="methodname"><a href="solrdocument.getfield.html" class="methodname">getField</a></span>
  120. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  121. )</div>
  122. <div class="methodsynopsis dc-description">
  123. <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="solrdocument.getfieldcount.html" class="methodname">getFieldCount</a></span>
  124. ( <span class="methodparam">void</span>
  125. )</div>
  126. <div class="methodsynopsis dc-description">
  127. <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="solrdocument.getfieldnames.html" class="methodname">getFieldNames</a></span>
  128. ( <span class="methodparam">void</span>
  129. )</div>
  130. <div class="methodsynopsis dc-description">
  131. <span class="modifier">public</span> <span class="type">SolrInputDocument</span> <span class="methodname"><a href="solrdocument.getinputdocument.html" class="methodname">getInputDocument</a></span>
  132. ( <span class="methodparam">void</span>
  133. )</div>
  134. <div class="methodsynopsis dc-description">
  135. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.isset.html" class="methodname">__isset</a></span>
  136. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  137. )</div>
  138. <div class="methodsynopsis dc-description">
  139. <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrdocument.key.html" class="methodname">key</a></span>
  140. ( <span class="methodparam">void</span>
  141. )</div>
  142. <div class="methodsynopsis dc-description">
  143. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.merge.html" class="methodname">merge</a></span>
  144. ( <span class="methodparam"><span class="type"><a href="class.solrdocument.html" class="type SolrDocument">SolrDocument</a></span> <tt class="parameter">$sourceDoc</tt></span>
  145. [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$overwrite</tt><span class="initializer"> = true</span></span>
  146. ] )</div>
  147. <div class="methodsynopsis dc-description">
  148. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.next.html" class="methodname">next</a></span>
  149. ( <span class="methodparam">void</span>
  150. )</div>
  151. <div class="methodsynopsis dc-description">
  152. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.offsetexists.html" class="methodname">offsetExists</a></span>
  153. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  154. )</div>
  155. <div class="methodsynopsis dc-description">
  156. <span class="modifier">public</span> <span class="type">SolrDocumentField</span> <span class="methodname"><a href="solrdocument.offsetget.html" class="methodname">offsetGet</a></span>
  157. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  158. )</div>
  159. <div class="methodsynopsis dc-description">
  160. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.offsetset.html" class="methodname">offsetSet</a></span>
  161. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  162. , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldValue</tt></span>
  163. )</div>
  164. <div class="methodsynopsis dc-description">
  165. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.offsetunset.html" class="methodname">offsetUnset</a></span>
  166. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  167. )</div>
  168. <div class="methodsynopsis dc-description">
  169. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.reset.html" class="methodname">reset</a></span>
  170. ( <span class="methodparam">void</span>
  171. )</div>
  172. <div class="methodsynopsis dc-description">
  173. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.rewind.html" class="methodname">rewind</a></span>
  174. ( <span class="methodparam">void</span>
  175. )</div>
  176. <div class="methodsynopsis dc-description">
  177. <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrdocument.serialize.html" class="methodname">serialize</a></span>
  178. ( <span class="methodparam">void</span>
  179. )</div>
  180. <div class="methodsynopsis dc-description">
  181. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.set.html" class="methodname">__set</a></span>
  182. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  183. , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldValue</tt></span>
  184. )</div>
  185. <div class="methodsynopsis dc-description">
  186. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.sort.html" class="methodname">sort</a></span>
  187. ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$sortOrderBy</tt></span>
  188. [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$sortDirection</tt><span class="initializer"> = SolrDocument::SORT_ASC</span></span>
  189. ] )</div>
  190. <div class="methodsynopsis dc-description">
  191. <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="solrdocument.toarray.html" class="methodname">toArray</a></span>
  192. ( <span class="methodparam">void</span>
  193. )</div>
  194. <div class="methodsynopsis dc-description">
  195. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrdocument.unserialize.html" class="methodname">unserialize</a></span>
  196. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$serialized</tt></span>
  197. )</div>
  198. <div class="methodsynopsis dc-description">
  199. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.unset.html" class="methodname">__unset</a></span>
  200. ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fieldName</tt></span>
  201. )</div>
  202. <div class="methodsynopsis dc-description">
  203. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="solrdocument.valid.html" class="methodname">valid</a></span>
  204. ( <span class="methodparam">void</span>
  205. )</div>
  206. }</div>
  207. </div>
  208. <div class="section" id="solrdocument.constants">
  209. <h2 class="title">定義済み定数</h2>
  210. <div class="section" id="solrdocument.constants.types">
  211. <h2 class="title">SolrDocument Node Types</h2>
  212. <dl>
  213. <dt id="solrdocument.constants.sort-default">
  214. <span class="term"><b><tt>SolrDocument::SORT_DEFAULT</tt></b></span>
  215. <dd>
  216. <p class="para">Default mode for sorting fields within the document.</p>
  217. </dd>
  218. </dt>
  219. <dt id="solrdocument.constants.sort-asc">
  220. <span class="term"><b><tt>SolrDocument::SORT_ASC</tt></b></span>
  221. <dd>
  222. <p class="para">Sorts the fields in ascending order</p>
  223. </dd>
  224. </dt>
  225. <dt id="solrdocument.constants.sort-desc">
  226. <span class="term"><b><tt>SolrDocument::SORT_DESC</tt></b></span>
  227. <dd>
  228. <p class="para">Sorts the fields in descending order</p>
  229. </dd>
  230. </dt>
  231. <dt id="solrdocument.constants.sort-field-name">
  232. <span class="term"><b><tt>SolrDocument::SORT_FIELD_NAME</tt></b></span>
  233. <dd>
  234. <p class="para">Sorts the fields by field name.</p>
  235. </dd>
  236. </dt>
  237. <dt id="solrdocument.constants.sort-field-value-count">
  238. <span class="term"><b><tt>SolrDocument::SORT_FIELD_VALUE_COUNT</tt></b></span>
  239. <dd>
  240. <p class="para">Sorts the fields by number of values in each field.</p>
  241. </dd>
  242. </dt>
  243. <dt id="solrdocument.constants.sort-field-boost-value">
  244. <span class="term"><b><tt>SolrDocument::SORT_FIELD_BOOST_VALUE</tt></b></span>
  245. <dd>
  246. <p class="para">Sorts the fields by thier boost values.</p>
  247. </dd>
  248. </dt>
  249. </dl>
  250. </div>
  251. </div>
  252. </div>
  253. <h2>目次</h2><ul class="chunklist chunklist_reference"><li><a href="solrdocument.addfield.html">SolrDocument::addField</a> Adds a field to the document</li><li><a href="solrdocument.clear.html">SolrDocument::clear</a> Drops all the fields in the document</li><li><a href="solrdocument.clone.html">SolrDocument::__clone</a> Creates a copy of a SolrDocument object</li><li><a href="solrdocument.construct.html">SolrDocument::__construct</a> Constructor</li><li><a href="solrdocument.current.html">SolrDocument::current</a> Retrieves the current field</li><li><a href="solrdocument.deletefield.html">SolrDocument::deleteField</a> Removes a field from the document</li><li><a href="solrdocument.destruct.html">SolrDocument::__destruct</a> Destructor</li><li><a href="solrdocument.fieldexists.html">SolrDocument::fieldExists</a> Checks if a field exists in the document</li><li><a href="solrdocument.get.html">SolrDocument::__get</a> Acess the field as a property</li><li><a href="solrdocument.getfield.html">SolrDocument::getField</a> Retrieves a field by name</li><li><a href="solrdocument.getfieldcount.html">SolrDocument::getFieldCount</a> Returns the number of fields in this document</li><li><a href="solrdocument.getfieldnames.html">SolrDocument::getFieldNames</a> Returns an array of fields names in the document</li><li><a href="solrdocument.getinputdocument.html">SolrDocument::getInputDocument</a> Returns a SolrInputDocument equivalent of the object</li><li><a href="solrdocument.isset.html">SolrDocument::__isset</a> Checks if a field exists</li><li><a href="solrdocument.key.html">SolrDocument::key</a> Retrieves the current key</li><li><a href="solrdocument.merge.html">SolrDocument::merge</a> Merges source to the current SolrDocument</li><li><a href="solrdocument.next.html">SolrDocument::next</a> Moves the internal pointer to the next field</li><li><a href="solrdocument.offsetexists.html">SolrDocument::offsetExists</a> Checks if a particular field exists</li><li><a href="solrdocument.offsetget.html">SolrDocument::offsetGet</a> Retrieves a field</li><li><a href="solrdocument.offsetset.html">SolrDocument::offsetSet</a> Adds a field to the document</li><li><a href="solrdocument.offsetunset.html">SolrDocument::offsetUnset</a> Removes a field</li><li><a href="solrdocument.reset.html">SolrDocument::reset</a> This is an alias to SolrDocument::clear()</li><li><a href="solrdocument.rewind.html">SolrDocument::rewind</a> Resets the internal pointer to the beginning</li><li><a href="solrdocument.serialize.html">SolrDocument::serialize</a> Used for custom serialization</li><li><a href="solrdocument.set.html">SolrDocument::__set</a> Adds another field to the document</li><li><a href="solrdocument.sort.html">SolrDocument::sort</a> Sorts the fields in the document</li><li><a href="solrdocument.toarray.html">SolrDocument::toArray</a> Returns an array representation of the document</li><li><a href="solrdocument.unserialize.html">SolrDocument::unserialize</a> Custom serialization of SolrDocument objects</li><li><a href="solrdocument.unset.html">SolrDocument::__unset</a> Removes a field from the document</li><li><a href="solrdocument.valid.html">SolrDocument::valid</a> Checks if the current position internally is still valid</li></ul>
  254. </div>
  255. <hr /><div class="manualnavbar" style="text-align: center;">
  256. <div class="prev" style="text-align: left; float: left;"><a href="solrinputdocument.toarray.html">SolrInputDocument::toArray</a></div>
  257. <div class="next" style="text-align: right; float: right;"><a href="solrdocument.addfield.html">SolrDocument::addField</a></div>
  258. <div class="up"><a href="book.solr.html">Solr</a></div>
  259. <div class="home"><a href="index.html">PHP Manual</a></div>
  260. </div></body></html>