Apache_Solr_Document.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901
  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_Document</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_Document</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  19. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  21. </div>
  22. <div class="info-box-body">
  23. <p class="implements">
  24. Implements interfaces:
  25. <ul>
  26. <li>IteratorAggregate (internal interface)</li> </ul>
  27. </p>
  28. <!-- ========== Info from phpDoc block ========= -->
  29. <p class="short-description">Holds Key / Value pairs that represent a Solr Document along with any associated boost values. Field values can be accessed by direct dereferencing such as:</p>
  30. <p class="description"><p>$document-&gt;title = 'Something'; echo $document-&gt;title; ... &lt;/code&gt;</p><p>Additionally, the field values can be iterated with foreach</p><p><div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-key">foreach&nbsp;</span><span class="src-sym">(</span><span class="src-var">$document&nbsp;</span><span class="src-key">as&nbsp;</span><span class="src-var">$fieldName&nbsp;</span>=&gt;&nbsp;<span class="src-var">$fieldValue</span><span class="src-sym">)</span></div></li>
  31. <li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
  32. <li><div class="src-line">&nbsp;...</div></li>
  33. <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
  34. </ol></div></p></p>
  35. <p class="notes">
  36. Located in <a class="field" href="_Document.php.html">/Document.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a58">58</a></span>)
  37. </p>
  38. <pre></pre>
  39. </div>
  40. </div>
  41. <a name="sec-const-summary"></a>
  42. <div class="info-box">
  43. <div class="info-box-title">Class Constant Summary</span></div>
  44. <div class="nav-bar">
  45. <a href="#sec-description">Description</a> |
  46. <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  47. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  48. |
  49. |
  50. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  51. </div>
  52. <div class="info-box-body">
  53. <div class="const-summary">
  54. <div class="const-title">
  55. <img src="../../media/images/Constant.png" alt=" " />
  56. <a href="#SVN_ID" title="details" class="const-name">SVN_ID</a> = <span class="var-type"> '$Id: Document.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span>
  57. </div>
  58. <div class="const-title">
  59. <img src="../../media/images/Constant.png" alt=" " />
  60. <a href="#SVN_REVISION" title="details" class="const-name">SVN_REVISION</a> = <span class="var-type"> '$Revision: 54 $'</span>
  61. </div>
  62. </div>
  63. </div>
  64. </div>
  65. <a name="sec-var-summary"></a>
  66. <div class="info-box">
  67. <div class="info-box-title">Variable Summary</span></div>
  68. <div class="nav-bar">
  69. <a href="#sec-description">Description</a> |
  70. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  71. |
  72. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  73. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  74. </div>
  75. <div class="info-box-body">
  76. <div class="var-summary">
  77. <div class="var-title">
  78. <span class="var-type">float</span>
  79. <a href="#$_documentBoost" title="details" class="var-name">$_documentBoost</a>
  80. </div>
  81. <div class="var-title">
  82. <span class="var-type">array</span>
  83. <a href="#$_fieldBoosts" title="details" class="var-name">$_fieldBoosts</a>
  84. </div>
  85. <div class="var-title">
  86. <span class="var-type">array</span>
  87. <a href="#$_fields" title="details" class="var-name">$_fields</a>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <a name="sec-method-summary"></a>
  93. <div class="info-box">
  94. <div class="info-box-title">Method Summary</span></div>
  95. <div class="nav-bar">
  96. <a href="#sec-description">Description</a> |
  97. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  98. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  99. |
  100. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  101. </div>
  102. <div class="info-box-body">
  103. <div class="method-summary">
  104. <div class="method-definition">
  105. <span class="method-result">void</span>
  106. <a href="#addField" title="details" class="method-name">addField</a>
  107. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  108. </div>
  109. <div class="method-definition">
  110. <span class="method-result">void</span>
  111. <a href="#clear" title="details" class="method-name">clear</a>
  112. ()
  113. </div>
  114. <div class="method-definition">
  115. <span class="method-result">mixed</span>
  116. <a href="#getBoost" title="details" class="method-name">getBoost</a>
  117. ()
  118. </div>
  119. <div class="method-definition">
  120. <span class="method-result">mixed</span>
  121. <a href="#getField" title="details" class="method-name">getField</a>
  122. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  123. </div>
  124. <div class="method-definition">
  125. <span class="method-result">float</span>
  126. <a href="#getFieldBoost" title="details" class="method-name">getFieldBoost</a>
  127. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  128. </div>
  129. <div class="method-definition">
  130. <span class="method-result">array</span>
  131. <a href="#getFieldBoosts" title="details" class="method-name">getFieldBoosts</a>
  132. ()
  133. </div>
  134. <div class="method-definition">
  135. <span class="method-result">array</span>
  136. <a href="#getFieldNames" title="details" class="method-name">getFieldNames</a>
  137. ()
  138. </div>
  139. <div class="method-definition">
  140. <span class="method-result">array</span>
  141. <a href="#getFieldValues" title="details" class="method-name">getFieldValues</a>
  142. ()
  143. </div>
  144. <div class="method-definition">
  145. <span class="method-result">void</span>
  146. <a href="#getIterator" title="details" class="method-name">getIterator</a>
  147. ()
  148. </div>
  149. <div class="method-definition">
  150. <span class="method-result">void</span>
  151. <a href="#setBoost" title="details" class="method-name">setBoost</a>
  152. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span>)
  153. </div>
  154. <div class="method-definition">
  155. <span class="method-result">void</span>
  156. <a href="#setField" title="details" class="method-name">setField</a>
  157. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  158. </div>
  159. <div class="method-definition">
  160. <span class="method-result">void</span>
  161. <a href="#setFieldBoost" title="details" class="method-name">setFieldBoost</a>
  162. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span>)
  163. </div>
  164. <div class="method-definition">
  165. <span class="method-result">void</span>
  166. <a href="#setMultiValue" title="details" class="method-name">setMultiValue</a>
  167. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  168. </div>
  169. <div class="method-definition">
  170. <span class="method-result">mixed</span>
  171. <a href="#__get" title="details" class="method-name">__get</a>
  172. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  173. </div>
  174. <div class="method-definition">
  175. <span class="method-result">boolean</span>
  176. <a href="#__isset" title="details" class="method-name">__isset</a>
  177. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  178. </div>
  179. <div class="method-definition">
  180. <span class="method-result">void</span>
  181. <a href="#__set" title="details" class="method-name">__set</a>
  182. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
  183. </div>
  184. <div class="method-definition">
  185. <span class="method-result">void</span>
  186. <a href="#__unset" title="details" class="method-name">__unset</a>
  187. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  188. </div>
  189. </div>
  190. </div>
  191. </div>
  192. <a name="sec-vars"></a>
  193. <div class="info-box">
  194. <div class="info-box-title">Variables</div>
  195. <div class="nav-bar">
  196. <a href="#sec-description">Description</a> |
  197. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  198. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  199. |
  200. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  201. </div>
  202. <div class="info-box-body">
  203. <a name="var$_documentBoost" id="$_documentBoost"><!-- --></A>
  204. <div class="evenrow">
  205. <div class="var-header">
  206. <span class="var-title">
  207. <span class="var-type">float</span>
  208. <span class="var-name">$_documentBoost</span>
  209. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a75">75</a></span>)
  210. </span>
  211. </div>
  212. <!-- ========== Info from phpDoc block ========= -->
  213. <p class="short-description">Document boost value</p>
  214. <ul class="tags">
  215. <li><span class="field">access:</span> protected</li>
  216. </ul>
  217. </div>
  218. <a name="var$_fieldBoosts" id="$_fieldBoosts"><!-- --></A>
  219. <div class="oddrow">
  220. <div class="var-header">
  221. <span class="var-title">
  222. <span class="var-type">array</span>
  223. <span class="var-name">$_fieldBoosts</span>
  224. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a89">89</a></span>)
  225. </span>
  226. </div>
  227. <!-- ========== Info from phpDoc block ========= -->
  228. <p class="short-description">Document field boost values, indexed by name</p>
  229. <ul class="tags">
  230. <li><span class="field">var:</span> array of floats</li>
  231. <li><span class="field">access:</span> protected</li>
  232. </ul>
  233. </div>
  234. <a name="var$_fields" id="$_fields"><!-- --></A>
  235. <div class="evenrow">
  236. <div class="var-header">
  237. <span class="var-title">
  238. <span class="var-type">array</span>
  239. <span class="var-name">$_fields</span>
  240. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a82">82</a></span>)
  241. </span>
  242. </div>
  243. <!-- ========== Info from phpDoc block ========= -->
  244. <p class="short-description">Document field values, indexed by name</p>
  245. <ul class="tags">
  246. <li><span class="field">access:</span> protected</li>
  247. </ul>
  248. </div>
  249. </div>
  250. </div>
  251. <a name="sec-methods"></a>
  252. <div class="info-box">
  253. <div class="info-box-title">Methods</div>
  254. <div class="nav-bar">
  255. <a href="#sec-description">Description</a> |
  256. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  257. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  258. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  259. </div>
  260. <div class="info-box-body">
  261. <A NAME='method_detail'></A>
  262. <a name="methodaddField" id="addField"><!-- --></a>
  263. <div class="oddrow">
  264. <div class="method-header">
  265. <span class="method-title">addField</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a154">154</a></span>)
  266. </div>
  267. <!-- ========== Info from phpDoc block ========= -->
  268. <p class="short-description">Add a value to a multi-valued field</p>
  269. <p class="description"><p>NOTE: the solr XML format allows you to specify boosts PER value even though the underlying Lucene implementation only allows a boost per field. To remedy this, the final field boost value will be the product of all specified boosts on field values - this is similar to SolrJ's functionality.</p><p><div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$doc&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  270. <li><div class="src-line">&nbsp;</div></li>
  271. <li><div class="src-line">&nbsp;<span class="src-var">$doc</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Document.html#methodaddField">addField</a><span class="src-sym">(</span><span class="src-str">'foo'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'bar'</span><span class="src-sym">,&nbsp;</span><span class="src-num">2.0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  272. <li><div class="src-line">&nbsp;<span class="src-var">$doc</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Document.html#methodaddField">addField</a><span class="src-sym">(</span><span class="src-str">'foo'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'baz'</span><span class="src-sym">,&nbsp;</span><span class="src-num">3.0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  273. <li><div class="src-line">&nbsp;</div></li>
  274. <li><div class="src-line">&nbsp;<span class="src-comm">//&nbsp;resultant&nbsp;field&nbsp;boost&nbsp;will&nbsp;be&nbsp;6!</span></div></li>
  275. <li><div class="src-line">&nbsp;echo&nbsp;<span class="src-var">$doc</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Document.html#methodgetFieldBoost">getFieldBoost</a><span class="src-sym">(</span><span class="src-str">'foo'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  276. </ol></div></p></p>
  277. <ul class="tags">
  278. <li><span class="field">access:</span> public</li>
  279. </ul>
  280. <div class="method-signature">
  281. <span class="method-result">void</span>
  282. <span class="method-name">
  283. addField
  284. </span>
  285. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  286. </div>
  287. <ul class="parameters">
  288. <li>
  289. <span class="var-type">string</span>
  290. <span class="var-name">$key</span> </li>
  291. <li>
  292. <span class="var-type">mixed</span>
  293. <span class="var-name">$value</span> </li>
  294. <li>
  295. <span class="var-type">mixed</span>
  296. <span class="var-name">$boost</span><span class="var-description">: Use false for default boost, else cast to float that should be &gt; 0 or will be treated as false</span> </li>
  297. </ul>
  298. </div>
  299. <a name="methodclear" id="clear"><!-- --></a>
  300. <div class="evenrow">
  301. <div class="method-header">
  302. <span class="method-title">clear</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a94">94</a></span>)
  303. </div>
  304. <!-- ========== Info from phpDoc block ========= -->
  305. <p class="short-description">Clear all boosts and fields from this document</p>
  306. <ul class="tags">
  307. <li><span class="field">access:</span> public</li>
  308. </ul>
  309. <div class="method-signature">
  310. <span class="method-result">void</span>
  311. <span class="method-name">
  312. clear
  313. </span>
  314. ()
  315. </div>
  316. </div>
  317. <a name="methodgetBoost" id="getBoost"><!-- --></a>
  318. <div class="oddrow">
  319. <div class="method-header">
  320. <span class="method-title">getBoost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a107">107</a></span>)
  321. </div>
  322. <!-- ========== Info from phpDoc block ========= -->
  323. <p class="short-description">Get current document boost</p>
  324. <ul class="tags">
  325. <li><span class="field">return:</span> will be false for default, or else a float</li>
  326. <li><span class="field">access:</span> public</li>
  327. </ul>
  328. <div class="method-signature">
  329. <span class="method-result">mixed</span>
  330. <span class="method-name">
  331. getBoost
  332. </span>
  333. ()
  334. </div>
  335. </div>
  336. <a name="methodgetField" id="getField"><!-- --></a>
  337. <div class="evenrow">
  338. <div class="method-header">
  339. <span class="method-title">getField</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a202">202</a></span>)
  340. </div>
  341. <!-- ========== Info from phpDoc block ========= -->
  342. <p class="short-description">Get field information</p>
  343. <ul class="tags">
  344. <li><span class="field">return:</span> associative array of info if field exists, false otherwise</li>
  345. <li><span class="field">access:</span> public</li>
  346. </ul>
  347. <div class="method-signature">
  348. <span class="method-result">mixed</span>
  349. <span class="method-name">
  350. getField
  351. </span>
  352. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  353. </div>
  354. <ul class="parameters">
  355. <li>
  356. <span class="var-type">string</span>
  357. <span class="var-name">$key</span> </li>
  358. </ul>
  359. </div>
  360. <a name="methodgetFieldBoost" id="getFieldBoost"><!-- --></a>
  361. <div class="oddrow">
  362. <div class="method-header">
  363. <span class="method-title">getFieldBoost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a237">237</a></span>)
  364. </div>
  365. <!-- ========== Info from phpDoc block ========= -->
  366. <p class="short-description">Get the currently set field boost for a document field</p>
  367. <ul class="tags">
  368. <li><span class="field">return:</span> currently set field boost, false if one is not set</li>
  369. <li><span class="field">access:</span> public</li>
  370. </ul>
  371. <div class="method-signature">
  372. <span class="method-result">float</span>
  373. <span class="method-name">
  374. getFieldBoost
  375. </span>
  376. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  377. </div>
  378. <ul class="parameters">
  379. <li>
  380. <span class="var-type">string</span>
  381. <span class="var-name">$key</span> </li>
  382. </ul>
  383. </div>
  384. <a name="methodgetFieldBoosts" id="getFieldBoosts"><!-- --></a>
  385. <div class="evenrow">
  386. <div class="method-header">
  387. <span class="method-title">getFieldBoosts</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a267">267</a></span>)
  388. </div>
  389. <!-- ========== Info from phpDoc block ========= -->
  390. <p class="short-description">Return current field boosts, indexed by field name</p>
  391. <ul class="tags">
  392. <li><span class="field">access:</span> public</li>
  393. </ul>
  394. <div class="method-signature">
  395. <span class="method-result">array</span>
  396. <span class="method-name">
  397. getFieldBoosts
  398. </span>
  399. ()
  400. </div>
  401. </div>
  402. <a name="methodgetFieldNames" id="getFieldNames"><!-- --></a>
  403. <div class="oddrow">
  404. <div class="method-header">
  405. <span class="method-title">getFieldNames</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a277">277</a></span>)
  406. </div>
  407. <!-- ========== Info from phpDoc block ========= -->
  408. <p class="short-description">Get the names of all fields in this document</p>
  409. <ul class="tags">
  410. <li><span class="field">access:</span> public</li>
  411. </ul>
  412. <div class="method-signature">
  413. <span class="method-result">array</span>
  414. <span class="method-name">
  415. getFieldNames
  416. </span>
  417. ()
  418. </div>
  419. </div>
  420. <a name="methodgetFieldValues" id="getFieldValues"><!-- --></a>
  421. <div class="evenrow">
  422. <div class="method-header">
  423. <span class="method-title">getFieldValues</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a287">287</a></span>)
  424. </div>
  425. <!-- ========== Info from phpDoc block ========= -->
  426. <p class="short-description">Get the values of all fields in this document</p>
  427. <ul class="tags">
  428. <li><span class="field">access:</span> public</li>
  429. </ul>
  430. <div class="method-signature">
  431. <span class="method-result">array</span>
  432. <span class="method-name">
  433. getFieldValues
  434. </span>
  435. ()
  436. </div>
  437. </div>
  438. <a name="methodgetIterator" id="getIterator"><!-- --></a>
  439. <div class="oddrow">
  440. <div class="method-header">
  441. <span class="method-title">getIterator</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a302">302</a></span>)
  442. </div>
  443. <!-- ========== Info from phpDoc block ========= -->
  444. <p class="short-description">IteratorAggregate implementation function. Allows usage:</p>
  445. <p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-key">foreach&nbsp;</span><span class="src-sym">(</span><span class="src-var">$document&nbsp;</span><span class="src-key">as&nbsp;</span><span class="src-var">$key&nbsp;</span>=&gt;&nbsp;<span class="src-var">$value</span><span class="src-sym">)</span></div></li>
  446. <li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
  447. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...</div></li>
  448. <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
  449. </ol></div></p></p>
  450. <ul class="tags">
  451. <li><span class="field">access:</span> public</li>
  452. </ul>
  453. <div class="method-signature">
  454. <span class="method-result">void</span>
  455. <span class="method-name">
  456. getIterator
  457. </span>
  458. ()
  459. </div>
  460. <hr class="separator" />
  461. <div class="notes">Implementation of:</div>
  462. <dl>
  463. <dt>IteratorAggregate::getIterator</dt>
  464. </dl>
  465. </div>
  466. <a name="methodsetBoost" id="setBoost"><!-- --></a>
  467. <div class="evenrow">
  468. <div class="method-header">
  469. <span class="method-title">setBoost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a117">117</a></span>)
  470. </div>
  471. <!-- ========== Info from phpDoc block ========= -->
  472. <p class="short-description">Set document boost factor</p>
  473. <ul class="tags">
  474. <li><span class="field">access:</span> public</li>
  475. </ul>
  476. <div class="method-signature">
  477. <span class="method-result">void</span>
  478. <span class="method-name">
  479. setBoost
  480. </span>
  481. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span>)
  482. </div>
  483. <ul class="parameters">
  484. <li>
  485. <span class="var-type">mixed</span>
  486. <span class="var-name">$boost</span><span class="var-description">: Use false for default boost, else cast to float that should be &gt; 0 or will be treated as false</span> </li>
  487. </ul>
  488. </div>
  489. <a name="methodsetField" id="setField"><!-- --></a>
  490. <div class="oddrow">
  491. <div class="method-header">
  492. <span class="method-title">setField</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a225">225</a></span>)
  493. </div>
  494. <!-- ========== Info from phpDoc block ========= -->
  495. <p class="short-description">Set a field value. Multi-valued fields should be set as arrays or instead use the addField(...) function which will automatically make sure the field is an array.</p>
  496. <ul class="tags">
  497. <li><span class="field">access:</span> public</li>
  498. </ul>
  499. <div class="method-signature">
  500. <span class="method-result">void</span>
  501. <span class="method-name">
  502. setField
  503. </span>
  504. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  505. </div>
  506. <ul class="parameters">
  507. <li>
  508. <span class="var-type">string</span>
  509. <span class="var-name">$key</span> </li>
  510. <li>
  511. <span class="var-type">mixed</span>
  512. <span class="var-name">$value</span> </li>
  513. <li>
  514. <span class="var-type">mixed</span>
  515. <span class="var-name">$boost</span><span class="var-description">: Use false for default boost, else cast to float that should be &gt; 0 or will be treated as false</span> </li>
  516. </ul>
  517. </div>
  518. <a name="methodsetFieldBoost" id="setFieldBoost"><!-- --></a>
  519. <div class="evenrow">
  520. <div class="method-header">
  521. <span class="method-title">setFieldBoost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a248">248</a></span>)
  522. </div>
  523. <!-- ========== Info from phpDoc block ========= -->
  524. <p class="short-description">Set the field boost for a document field</p>
  525. <ul class="tags">
  526. <li><span class="field">access:</span> public</li>
  527. </ul>
  528. <div class="method-signature">
  529. <span class="method-result">void</span>
  530. <span class="method-name">
  531. setFieldBoost
  532. </span>
  533. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span>)
  534. </div>
  535. <ul class="parameters">
  536. <li>
  537. <span class="var-type">string</span>
  538. <span class="var-name">$key</span><span class="var-description">: field name for the boost</span> </li>
  539. <li>
  540. <span class="var-type">mixed</span>
  541. <span class="var-name">$boost</span><span class="var-description">: Use false for default boost, else cast to float that should be &gt; 0 or will be treated as false</span> </li>
  542. </ul>
  543. </div>
  544. <a name="methodsetMultiValue" id="setMultiValue"><!-- --></a>
  545. <div class="oddrow">
  546. <div class="method-header">
  547. <span class="method-title">setMultiValue</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a191">191</a></span>)
  548. </div>
  549. <!-- ========== Info from phpDoc block ========= -->
  550. <p class="short-description">Handle the array manipulation for a multi-valued field</p>
  551. <ul class="tags">
  552. <li><span class="field">deprecated:</span> Use addField(...) instead</li>
  553. <li><span class="field">access:</span> public</li>
  554. </ul>
  555. <div class="method-signature">
  556. <span class="method-result">void</span>
  557. <span class="method-name">
  558. setMultiValue
  559. </span>
  560. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boost</span> = <span class="var-default">false</span>])
  561. </div>
  562. <ul class="parameters">
  563. <li>
  564. <span class="var-type">string</span>
  565. <span class="var-name">$key</span> </li>
  566. <li>
  567. <span class="var-type">string</span>
  568. <span class="var-name">$value</span> </li>
  569. <li>
  570. <span class="var-type">mixed</span>
  571. <span class="var-name">$boost</span><span class="var-description">: Use false for default boost, else cast to float that should be &gt; 0 or will be treated as false</span> </li>
  572. </ul>
  573. </div>
  574. <a name="method__get" id="__get"><!-- --></a>
  575. <div class="evenrow">
  576. <div class="method-header">
  577. <span class="method-title">__get</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a315">315</a></span>)
  578. </div>
  579. <!-- ========== Info from phpDoc block ========= -->
  580. <p class="short-description">Magic get for field values</p>
  581. <ul class="tags">
  582. <li><span class="field">access:</span> public</li>
  583. </ul>
  584. <div class="method-signature">
  585. <span class="method-result">mixed</span>
  586. <span class="method-name">
  587. __get
  588. </span>
  589. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  590. </div>
  591. <ul class="parameters">
  592. <li>
  593. <span class="var-type">string</span>
  594. <span class="var-name">$key</span> </li>
  595. </ul>
  596. </div>
  597. <a name="method__isset" id="__isset"><!-- --></a>
  598. <div class="oddrow">
  599. <div class="method-header">
  600. <span class="method-title">__isset</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a348">348</a></span>)
  601. </div>
  602. <!-- ========== Info from phpDoc block ========= -->
  603. <p class="short-description">Magic isset for fields values. Do not call directly. Allows usage:</p>
  604. <p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;isset<span class="src-sym">(</span><span class="src-var">$document</span><span class="src-sym">-&gt;</span><span class="src-id">some_field</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  605. </ol></div></p></p>
  606. <ul class="tags">
  607. <li><span class="field">access:</span> public</li>
  608. </ul>
  609. <div class="method-signature">
  610. <span class="method-result">boolean</span>
  611. <span class="method-name">
  612. __isset
  613. </span>
  614. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  615. </div>
  616. <ul class="parameters">
  617. <li>
  618. <span class="var-type">string</span>
  619. <span class="var-name">$key</span> </li>
  620. </ul>
  621. </div>
  622. <a name="method__set" id="__set"><!-- --></a>
  623. <div class="evenrow">
  624. <div class="method-header">
  625. <span class="method-title">__set</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a333">333</a></span>)
  626. </div>
  627. <!-- ========== Info from phpDoc block ========= -->
  628. <p class="short-description">Magic set for field values. Multi-valued fields should be set as arrays or instead use the addField(...) function which will automatically make sure the field is an array.</p>
  629. <ul class="tags">
  630. <li><span class="field">access:</span> public</li>
  631. </ul>
  632. <div class="method-signature">
  633. <span class="method-result">void</span>
  634. <span class="method-name">
  635. __set
  636. </span>
  637. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
  638. </div>
  639. <ul class="parameters">
  640. <li>
  641. <span class="var-type">string</span>
  642. <span class="var-name">$key</span> </li>
  643. <li>
  644. <span class="var-type">mixed</span>
  645. <span class="var-name">$value</span> </li>
  646. </ul>
  647. </div>
  648. <a name="method__unset" id="__unset"><!-- --></a>
  649. <div class="oddrow">
  650. <div class="method-header">
  651. <span class="method-title">__unset</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a362">362</a></span>)
  652. </div>
  653. <!-- ========== Info from phpDoc block ========= -->
  654. <p class="short-description">Magic unset for field values. Do not call directly. Allows usage:</p>
  655. <p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;unset<span class="src-sym">(</span><span class="src-var">$document</span><span class="src-sym">-&gt;</span><span class="src-id">some_field</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  656. </ol></div></p></p>
  657. <ul class="tags">
  658. <li><span class="field">access:</span> public</li>
  659. </ul>
  660. <div class="method-signature">
  661. <span class="method-result">void</span>
  662. <span class="method-name">
  663. __unset
  664. </span>
  665. (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
  666. </div>
  667. <ul class="parameters">
  668. <li>
  669. <span class="var-type">string</span>
  670. <span class="var-name">$key</span> </li>
  671. </ul>
  672. </div>
  673. </div>
  674. </div>
  675. <a name="sec-consts"></a>
  676. <div class="info-box">
  677. <div class="info-box-title">Class Constants</div>
  678. <div class="nav-bar">
  679. <a href="#sec-description">Description</a> |
  680. <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
  681. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  682. |
  683. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  684. </div>
  685. <div class="info-box-body">
  686. <a name="constSVN_ID" id="SVN_ID"><!-- --></A>
  687. <div class="evenrow">
  688. <div class="const-header">
  689. <img src="../../media/images/Variable.png" />
  690. <span class="const-title">
  691. <span class="const-name">SVN_ID</span>
  692. = <span class="const-default"> '$Id: Document.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span>
  693. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a68">68</a></span>)
  694. </span>
  695. </div>
  696. <!-- ========== Info from phpDoc block ========= -->
  697. <p class="short-description">SVN ID meta data for this class</p>
  698. </div>
  699. <a name="constSVN_REVISION" id="SVN_REVISION"><!-- --></A>
  700. <div class="oddrow">
  701. <div class="const-header">
  702. <img src="../../media/images/Variable.png" />
  703. <span class="const-title">
  704. <span class="const-name">SVN_REVISION</span>
  705. = <span class="const-default"> '$Revision: 54 $'</span>
  706. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Document.php.html#a63">63</a></span>)
  707. </span>
  708. </div>
  709. <!-- ========== Info from phpDoc block ========= -->
  710. <p class="short-description">SVN Revision meta data for this class</p>
  711. </div>
  712. </div>
  713. </div>
  714. <p class="notes" id="credit">
  715. Documentation generated on Wed, 04 May 2011 11:01:13 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  716. </p>
  717. </div></body>
  718. </html>