Apache_Solr_Service.html 113 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473
  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_Service</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_Service</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. <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">Starting point for the Solr API. Represents a Solr server resource and has methods for pinging, adding, deleting, committing, optimizing and searching.</p>
  25. <p class="description"><p>Example Usage: <div class="src-code"><ol><li><div class="src-line">&nbsp;...</div></li>
  26. <li><div class="src-line">&nbsp;<span class="src-var">$solr&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;</span><span class="src-comm">//or&nbsp;explicitly&nbsp;new&nbsp;Apache_Solr_Service('localhost',&nbsp;8180,&nbsp;'/solr')</span></div></li>
  27. <li><div class="src-line">&nbsp;</div></li>
  28. <li><div class="src-line">&nbsp;<span class="src-key">if&nbsp;</span><span class="src-sym">(</span><span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodping">ping</a><span class="src-sym">(</span><span class="src-sym">))</span></div></li>
  29. <li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
  30. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methoddeleteByQuery">deleteByQuery</a><span class="src-sym">(</span><span class="src-str">'*:*'</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;</span><span class="src-comm">//deletes&nbsp;ALL&nbsp;documents&nbsp;-&nbsp;be&nbsp;careful&nbsp;:)</span></div></li>
  31. <li><div class="src-line">&nbsp;</div></li>
  32. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$document&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>
  33. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$document</span><span class="src-sym">-&gt;</span><span class="src-id">id&nbsp;</span>=&nbsp;<a href="http://www.php.net/uniqid">uniqid</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;</span><span class="src-comm">//or&nbsp;something&nbsp;else&nbsp;suitably&nbsp;unique</span></div></li>
  34. <li><div class="src-line">&nbsp;</div></li>
  35. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$document</span><span class="src-sym">-&gt;</span><span class="src-id">title&nbsp;</span>=&nbsp;<span class="src-str">'Some&nbsp;Title'</span><span class="src-sym">;</span></div></li>
  36. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$document</span><span class="src-sym">-&gt;</span><span class="src-id">content&nbsp;</span>=&nbsp;<span class="src-str">'Some&nbsp;content&nbsp;for&nbsp;this&nbsp;wonderful&nbsp;document.&nbsp;Blah&nbsp;blah&nbsp;blah.'</span><span class="src-sym">;</span></div></li>
  37. <li><div class="src-line">&nbsp;</div></li>
  38. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodaddDocument">addDocument</a><span class="src-sym">(</span><span class="src-var">$document</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="src-comm">//if&nbsp;you're&nbsp;going&nbsp;to&nbsp;be&nbsp;adding&nbsp;documents&nbsp;in&nbsp;bulk&nbsp;using&nbsp;addDocuments</span></div></li>
  39. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-comm">//with&nbsp;an&nbsp;array&nbsp;of&nbsp;documents&nbsp;is&nbsp;faster</span></div></li>
  40. <li><div class="src-line">&nbsp;</div></li>
  41. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodcommit">commit</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;</span><span class="src-comm">//commit&nbsp;to&nbsp;see&nbsp;the&nbsp;deletes&nbsp;and&nbsp;the&nbsp;document</span></div></li>
  42. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodoptimize">optimize</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;&nbsp;</span><span class="src-comm">//merges&nbsp;multiple&nbsp;segments&nbsp;into&nbsp;one</span></div></li>
  43. <li><div class="src-line">&nbsp;</div></li>
  44. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-comm">//and&nbsp;the&nbsp;one&nbsp;we&nbsp;all&nbsp;care&nbsp;about,&nbsp;search!</span></div></li>
  45. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-comm">//any&nbsp;other&nbsp;common&nbsp;or&nbsp;custom&nbsp;parameters&nbsp;to&nbsp;the&nbsp;request&nbsp;handler&nbsp;can&nbsp;go&nbsp;in&nbsp;the</span></div></li>
  46. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-comm">//optional&nbsp;4th&nbsp;array&nbsp;argument.</span></div></li>
  47. <li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$solr</span><span class="src-sym">-&gt;</span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodsearch">search</a><span class="src-sym">(</span><span class="src-str">'content:blah'</span><span class="src-sym">,&nbsp;</span><span class="src-num">0</span><span class="src-sym">,&nbsp;</span><span class="src-num">10</span><span class="src-sym">,&nbsp;</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'sort'&nbsp;</span>=&gt;&nbsp;<span class="src-str">'timestamp&nbsp;desc'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
  48. <li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
  49. <li><div class="src-line">&nbsp;...</div></li>
  50. </ol></div></p></p>
  51. <ul class="tags">
  52. <li><span class="field">todo:</span> Investigate using other HTTP clients other than file_get_contents built-in handler. Could provide performance improvements when dealing with multiple requests by using HTTP's keep alive functionality</li>
  53. </ul>
  54. <p class="notes">
  55. Located in <a class="field" href="_Service.php.html">/Service.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a86">86</a></span>)
  56. </p>
  57. <pre></pre>
  58. </div>
  59. </div>
  60. <a name="sec-const-summary"></a>
  61. <div class="info-box">
  62. <div class="info-box-title">Class Constant Summary</span></div>
  63. <div class="nav-bar">
  64. <a href="#sec-description">Description</a> |
  65. <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  66. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  67. |
  68. |
  69. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  70. </div>
  71. <div class="info-box-body">
  72. <div class="const-summary">
  73. <div class="const-title">
  74. <img src="../../media/images/Constant.png" alt=" " />
  75. <a href="#EXTRACT_SERVLET" title="details" class="const-name">EXTRACT_SERVLET</a> = <span class="var-type"> 'update/extract'</span>
  76. </div>
  77. <div class="const-title">
  78. <img src="../../media/images/Constant.png" alt=" " />
  79. <a href="#METHOD_GET" title="details" class="const-name">METHOD_GET</a> = <span class="var-type"> 'GET'</span>
  80. </div>
  81. <div class="const-title">
  82. <img src="../../media/images/Constant.png" alt=" " />
  83. <a href="#METHOD_POST" title="details" class="const-name">METHOD_POST</a> = <span class="var-type"> 'POST'</span>
  84. </div>
  85. <div class="const-title">
  86. <img src="../../media/images/Constant.png" alt=" " />
  87. <a href="#NAMED_LIST_FLAT" title="details" class="const-name">NAMED_LIST_FLAT</a> = <span class="var-type"> 'flat'</span>
  88. </div>
  89. <div class="const-title">
  90. <img src="../../media/images/Constant.png" alt=" " />
  91. <a href="#NAMED_LIST_MAP" title="details" class="const-name">NAMED_LIST_MAP</a> = <span class="var-type"> 'map'</span>
  92. </div>
  93. <div class="const-title">
  94. <img src="../../media/images/Constant.png" alt=" " />
  95. <a href="#PING_SERVLET" title="details" class="const-name">PING_SERVLET</a> = <span class="var-type"> 'admin/ping'</span>
  96. </div>
  97. <div class="const-title">
  98. <img src="../../media/images/Constant.png" alt=" " />
  99. <a href="#SEARCH_SERVLET" title="details" class="const-name">SEARCH_SERVLET</a> = <span class="var-type"> 'select'</span>
  100. </div>
  101. <div class="const-title">
  102. <img src="../../media/images/Constant.png" alt=" " />
  103. <a href="#SOLR_WRITER" title="details" class="const-name">SOLR_WRITER</a> = <span class="var-type"> 'json'</span>
  104. </div>
  105. <div class="const-title">
  106. <img src="../../media/images/Constant.png" alt=" " />
  107. <a href="#SVN_ID" title="details" class="const-name">SVN_ID</a> = <span class="var-type"> '$Id: Service.php 59 2011-02-08 20:38:59Z donovan.jimenez $'</span>
  108. </div>
  109. <div class="const-title">
  110. <img src="../../media/images/Constant.png" alt=" " />
  111. <a href="#SVN_REVISION" title="details" class="const-name">SVN_REVISION</a> = <span class="var-type"> '$Revision: 59 $'</span>
  112. </div>
  113. <div class="const-title">
  114. <img src="../../media/images/Constant.png" alt=" " />
  115. <a href="#THREADS_SERVLET" title="details" class="const-name">THREADS_SERVLET</a> = <span class="var-type"> 'admin/threads'</span>
  116. </div>
  117. <div class="const-title">
  118. <img src="../../media/images/Constant.png" alt=" " />
  119. <a href="#UPDATE_SERVLET" title="details" class="const-name">UPDATE_SERVLET</a> = <span class="var-type"> 'update'</span>
  120. </div>
  121. </div>
  122. </div>
  123. </div>
  124. <a name="sec-var-summary"></a>
  125. <div class="info-box">
  126. <div class="info-box-title">Variable Summary</span></div>
  127. <div class="nav-bar">
  128. <a href="#sec-description">Description</a> |
  129. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  130. |
  131. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  132. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  133. </div>
  134. <div class="info-box-body">
  135. <div class="var-summary">
  136. <div class="var-title">
  137. <span class="var-type">boolean</span>
  138. <a href="#$_collapseSingleValueArrays" title="details" class="var-name">$_collapseSingleValueArrays</a>
  139. </div>
  140. <div class="var-title">
  141. <span class="var-type">boolean</span>
  142. <a href="#$_createDocuments" title="details" class="var-name">$_createDocuments</a>
  143. </div>
  144. <div class="var-title">
  145. <span class="var-type">string</span>
  146. <a href="#$_host" title="details" class="var-name">$_host</a>
  147. </div>
  148. <div class="var-title">
  149. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
  150. <a href="#$_httpTransport" title="details" class="var-name">$_httpTransport</a>
  151. </div>
  152. <div class="var-title">
  153. <span class="var-type">string</span>
  154. <a href="#$_namedListTreatment" title="details" class="var-name">$_namedListTreatment</a>
  155. </div>
  156. <div class="var-title">
  157. <span class="var-type">mixed</span>
  158. <a href="#$_path" title="details" class="var-name">$_path</a>
  159. </div>
  160. <div class="var-title">
  161. <span class="var-type">string</span>
  162. <a href="#$_pingUrl" title="details" class="var-name">$_pingUrl</a>
  163. </div>
  164. <div class="var-title">
  165. <span class="var-type">mixed</span>
  166. <a href="#$_port" title="details" class="var-name">$_port</a>
  167. </div>
  168. <div class="var-title">
  169. <span class="var-type">mixed</span>
  170. <a href="#$_queryBracketsEscaped" title="details" class="var-name">$_queryBracketsEscaped</a>
  171. </div>
  172. <div class="var-title">
  173. <span class="var-type">string</span>
  174. <a href="#$_queryDelimiter" title="details" class="var-name">$_queryDelimiter</a>
  175. </div>
  176. <div class="var-title">
  177. <span class="var-type">mixed</span>
  178. <a href="#$_queryStringDelimiter" title="details" class="var-name">$_queryStringDelimiter</a>
  179. </div>
  180. <div class="var-title">
  181. <span class="var-type">mixed</span>
  182. <a href="#$_searchUrl" title="details" class="var-name">$_searchUrl</a>
  183. </div>
  184. <div class="var-title">
  185. <span class="var-type">mixed</span>
  186. <a href="#$_threadsUrl" title="details" class="var-name">$_threadsUrl</a>
  187. </div>
  188. <div class="var-title">
  189. <span class="var-type">mixed</span>
  190. <a href="#$_updateUrl" title="details" class="var-name">$_updateUrl</a>
  191. </div>
  192. <div class="var-title">
  193. <span class="var-type">boolean</span>
  194. <a href="#$_urlsInited" title="details" class="var-name">$_urlsInited</a>
  195. </div>
  196. </div>
  197. </div>
  198. </div>
  199. <a name="sec-method-summary"></a>
  200. <div class="info-box">
  201. <div class="info-box-title">Method Summary</span></div>
  202. <div class="nav-bar">
  203. <a href="#sec-description">Description</a> |
  204. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  205. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  206. |
  207. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  208. </div>
  209. <div class="info-box-body">
  210. <div class="method-summary">
  211. <div class="method-definition">
  212. static <span class="method-result">string</span>
  213. <a href="#escape" title="details" class="method-name">escape</a>
  214. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  215. </div>
  216. <div class="method-definition">
  217. static <span class="method-result">string</span>
  218. <a href="#escapePhrase" title="details" class="method-name">escapePhrase</a>
  219. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  220. </div>
  221. <div class="method-definition">
  222. static <span class="method-result">string</span>
  223. <a href="#phrase" title="details" class="method-name">phrase</a>
  224. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  225. </div>
  226. <div class="method-definition">
  227. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  228. <a href="#add" title="details" class="method-name">add</a>
  229. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>)
  230. </div>
  231. <div class="method-definition">
  232. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  233. <a href="#addDocument" title="details" class="method-name">addDocument</a>
  234. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
  235. </div>
  236. <div class="method-definition">
  237. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  238. <a href="#addDocuments" title="details" class="method-name">addDocuments</a>
  239. (<span class="var-type">array</span>&nbsp;<span class="var-name">$documents</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
  240. </div>
  241. <div class="method-definition">
  242. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  243. <a href="#commit" title="details" class="method-name">commit</a>
  244. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$expungeDeletes</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  245. </div>
  246. <div class="method-definition">
  247. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  248. <a href="#delete" title="details" class="method-name">delete</a>
  249. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  250. </div>
  251. <div class="method-definition">
  252. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  253. <a href="#deleteById" title="details" class="method-name">deleteById</a>
  254. (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  255. </div>
  256. <div class="method-definition">
  257. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  258. <a href="#deleteByMultipleIds" title="details" class="method-name">deleteByMultipleIds</a>
  259. (<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  260. </div>
  261. <div class="method-definition">
  262. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  263. <a href="#deleteByQuery" title="details" class="method-name">deleteByQuery</a>
  264. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  265. </div>
  266. <div class="method-definition">
  267. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  268. <a href="#extract" title="details" class="method-name">extract</a>
  269. (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  270. </div>
  271. <div class="method-definition">
  272. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  273. <a href="#extractFromString" title="details" class="method-name">extractFromString</a>
  274. (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  275. </div>
  276. <div class="method-definition">
  277. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  278. <a href="#extractFromUrl" title="details" class="method-name">extractFromUrl</a>
  279. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  280. </div>
  281. <div class="method-definition">
  282. <span class="method-result">boolean</span>
  283. <a href="#getCollapseSingleValueArrays" title="details" class="method-name">getCollapseSingleValueArrays</a>
  284. ()
  285. </div>
  286. <div class="method-definition">
  287. <span class="method-result">boolean</span>
  288. <a href="#getCreateDocuments" title="details" class="method-name">getCreateDocuments</a>
  289. ()
  290. </div>
  291. <div class="method-definition">
  292. <span class="method-result">float</span>
  293. <a href="#getDefaultTimeout" title="details" class="method-name">getDefaultTimeout</a>
  294. ()
  295. </div>
  296. <div class="method-definition">
  297. <span class="method-result">string</span>
  298. <a href="#getHost" title="details" class="method-name">getHost</a>
  299. ()
  300. </div>
  301. <div class="method-definition">
  302. <span class="method-result">HttpTransportInterface</span>
  303. <a href="#getHttpTransport" title="details" class="method-name">getHttpTransport</a>
  304. ()
  305. </div>
  306. <div class="method-definition">
  307. <span class="method-result">string</span>
  308. <a href="#getNamedListTreatment" title="details" class="method-name">getNamedListTreatment</a>
  309. ()
  310. </div>
  311. <div class="method-definition">
  312. <span class="method-result">string</span>
  313. <a href="#getPath" title="details" class="method-name">getPath</a>
  314. ()
  315. </div>
  316. <div class="method-definition">
  317. <span class="method-result">integer</span>
  318. <a href="#getPort" title="details" class="method-name">getPort</a>
  319. ()
  320. </div>
  321. <div class="method-definition">
  322. <span class="method-result">Apache_Solr_Service</span>
  323. <a href="#__construct" title="details" class="method-name">__construct</a>
  324. ([<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">'localhost'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">8180</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">'/solr/'</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>&nbsp;<span class="var-name">$httpTransport</span> = <span class="var-default">false</span>])
  325. </div>
  326. <div class="method-definition">
  327. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  328. <a href="#optimize" title="details" class="method-name">optimize</a>
  329. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  330. </div>
  331. <div class="method-definition">
  332. <span class="method-result">float</span>
  333. <a href="#ping" title="details" class="method-name">ping</a>
  334. ([<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">2</span>])
  335. </div>
  336. <div class="method-definition">
  337. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  338. <a href="#search" title="details" class="method-name">search</a>
  339. (<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">self::METHOD_GET</span>])
  340. </div>
  341. <div class="method-definition">
  342. <span class="method-result">void</span>
  343. <a href="#setCollapseSingleValueArrays" title="details" class="method-name">setCollapseSingleValueArrays</a>
  344. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapseSingleValueArrays</span>)
  345. </div>
  346. <div class="method-definition">
  347. <span class="method-result">void</span>
  348. <a href="#setCreateDocuments" title="details" class="method-name">setCreateDocuments</a>
  349. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createDocuments</span>)
  350. </div>
  351. <div class="method-definition">
  352. <span class="method-result">void</span>
  353. <a href="#setDefaultTimeout" title="details" class="method-name">setDefaultTimeout</a>
  354. (<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
  355. </div>
  356. <div class="method-definition">
  357. <span class="method-result">void</span>
  358. <a href="#setHost" title="details" class="method-name">setHost</a>
  359. (<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>)
  360. </div>
  361. <div class="method-definition">
  362. <span class="method-result">void</span>
  363. <a href="#setHttpTransport" title="details" class="method-name">setHttpTransport</a>
  364. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>&nbsp;<span class="var-name">$httpTransport</span>)
  365. </div>
  366. <div class="method-definition">
  367. <span class="method-result">void</span>
  368. <a href="#setNamedListTreatment" title="details" class="method-name">setNamedListTreatment</a>
  369. (<span class="var-type">string</span>&nbsp;<span class="var-name">$namedListTreatment</span>)
  370. </div>
  371. <div class="method-definition">
  372. <span class="method-result">void</span>
  373. <a href="#setPath" title="details" class="method-name">setPath</a>
  374. (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
  375. </div>
  376. <div class="method-definition">
  377. <span class="method-result">void</span>
  378. <a href="#setPort" title="details" class="method-name">setPort</a>
  379. (<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
  380. </div>
  381. <div class="method-definition">
  382. <span class="method-result">void</span>
  383. <a href="#setQueryDelimiter" title="details" class="method-name">setQueryDelimiter</a>
  384. (<span class="var-type">string</span>&nbsp;<span class="var-name">$queryDelimiter</span>)
  385. </div>
  386. <div class="method-definition">
  387. <span class="method-result">void</span>
  388. <a href="#setQueryStringDelimiter" title="details" class="method-name">setQueryStringDelimiter</a>
  389. (<span class="var-type">string</span>&nbsp;<span class="var-name">$queryStringDelimiter</span>)
  390. </div>
  391. <div class="method-definition">
  392. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  393. <a href="#threads" title="details" class="method-name">threads</a>
  394. ()
  395. </div>
  396. <div class="method-definition">
  397. <span class="method-result">string</span>
  398. <a href="#_constructUrl" title="details" class="method-name">_constructUrl</a>
  399. (<span class="var-type">string</span>&nbsp;<span class="var-name">$servlet</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
  400. </div>
  401. <div class="method-definition">
  402. <span class="method-result">string</span>
  403. <a href="#_documentToXmlFragment" title="details" class="method-name">_documentToXmlFragment</a>
  404. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>)
  405. </div>
  406. <div class="method-definition">
  407. <span class="method-result">void</span>
  408. <a href="#_generateQueryString" title="details" class="method-name">_generateQueryString</a>
  409. (<span class="var-type"></span>&nbsp;<span class="var-name">$params</span>)
  410. </div>
  411. <div class="method-definition">
  412. <span class="method-result">void</span>
  413. <a href="#_initUrls" title="details" class="method-name">_initUrls</a>
  414. ()
  415. </div>
  416. <div class="method-definition">
  417. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  418. <a href="#_sendRawGet" title="details" class="method-name">_sendRawGet</a>
  419. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>])
  420. </div>
  421. <div class="method-definition">
  422. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  423. <a href="#_sendRawPost" title="details" class="method-name">_sendRawPost</a>
  424. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span> = <span class="var-default">'text/xml; charset=UTF-8'</span>])
  425. </div>
  426. <div class="method-definition">
  427. <span class="method-result">string</span>
  428. <a href="#_stripCtrlChars" title="details" class="method-name">_stripCtrlChars</a>
  429. (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  430. </div>
  431. </div>
  432. </div>
  433. </div>
  434. <a name="sec-vars"></a>
  435. <div class="info-box">
  436. <div class="info-box-title">Variables</div>
  437. <div class="nav-bar">
  438. <a href="#sec-description">Description</a> |
  439. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  440. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  441. |
  442. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  443. </div>
  444. <div class="info-box-body">
  445. <a name="var$_collapseSingleValueArrays" id="$_collapseSingleValueArrays"><!-- --></A>
  446. <div class="oddrow">
  447. <div class="var-header">
  448. <span class="var-title">
  449. <span class="var-type">boolean</span>
  450. <span class="var-name">$_collapseSingleValueArrays</span>
  451. = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a145">145</a></span>)
  452. </span>
  453. </div>
  454. <!-- ========== Info from phpDoc block ========= -->
  455. <p class="short-description">Whether <a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a> objects should have multivalue fields with only a single value collapsed to appear as a single value would.</p>
  456. <ul class="tags">
  457. <li><span class="field">access:</span> protected</li>
  458. </ul>
  459. </div>
  460. <a name="var$_createDocuments" id="$_createDocuments"><!-- --></A>
  461. <div class="evenrow">
  462. <div class="var-header">
  463. <span class="var-title">
  464. <span class="var-type">boolean</span>
  465. <span class="var-name">$_createDocuments</span>
  466. = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a137">137</a></span>)
  467. </span>
  468. </div>
  469. <!-- ========== Info from phpDoc block ========= -->
  470. <p class="short-description">Whether <a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a> objects should create <a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a>s in the returned parsed data</p>
  471. <ul class="tags">
  472. <li><span class="field">access:</span> protected</li>
  473. </ul>
  474. </div>
  475. <a name="var$_host" id="$_host"><!-- --></A>
  476. <div class="oddrow">
  477. <div class="var-header">
  478. <span class="var-title">
  479. <span class="var-type">string</span>
  480. <span class="var-name">$_host</span>
  481. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
  482. </span>
  483. </div>
  484. <!-- ========== Info from phpDoc block ========= -->
  485. <p class="short-description">Server identification strings</p>
  486. <ul class="tags">
  487. <li><span class="field">access:</span> protected</li>
  488. </ul>
  489. </div>
  490. <a name="var$_httpTransport" id="$_httpTransport"><!-- --></A>
  491. <div class="evenrow">
  492. <div class="var-header">
  493. <span class="var-title">
  494. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
  495. <span class="var-name">$_httpTransport</span>
  496. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a182">182</a></span>)
  497. </span>
  498. </div>
  499. <!-- ========== Info from phpDoc block ========= -->
  500. <p class="short-description">HTTP Transport implementation (pluggable)</p>
  501. <ul class="tags">
  502. <li><span class="field">access:</span> protected</li>
  503. </ul>
  504. </div>
  505. <a name="var$_namedListTreatment" id="$_namedListTreatment"><!-- --></A>
  506. <div class="oddrow">
  507. <div class="var-header">
  508. <span class="var-title">
  509. <span class="var-type">string</span>
  510. <span class="var-name">$_namedListTreatment</span>
  511. = <span class="var-default"> self::NAMED_LIST_MAP</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a153">153</a></span>)
  512. </span>
  513. </div>
  514. <!-- ========== Info from phpDoc block ========= -->
  515. <p class="short-description">How NamedLists should be formatted in the output. This specifically effects facet counts. Valid values are <a href="../../Apache/Solr/Apache_Solr_Service.html#constNAMED_LIST_MAP">Apache_Solr_Service::NAMED_LIST_MAP</a> (default) or <a href="../../Apache/Solr/Apache_Solr_Service.html#constNAMED_LIST_FLAT">Apache_Solr_Service::NAMED_LIST_FLAT</a>.</p>
  516. <ul class="tags">
  517. <li><span class="field">access:</span> protected</li>
  518. </ul>
  519. </div>
  520. <a name="var$_path" id="$_path"><!-- --></A>
  521. <div class="evenrow">
  522. <div class="var-header">
  523. <span class="var-title">
  524. <span class="var-type">mixed</span>
  525. <span class="var-name">$_path</span>
  526. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
  527. </span>
  528. </div>
  529. <!-- ========== Info from phpDoc block ========= -->
  530. <ul class="tags">
  531. <li><span class="field">access:</span> protected</li>
  532. </ul>
  533. </div>
  534. <a name="var$_pingUrl" id="$_pingUrl"><!-- --></A>
  535. <div class="oddrow">
  536. <div class="var-header">
  537. <span class="var-title">
  538. <span class="var-type">string</span>
  539. <span class="var-name">$_pingUrl</span>
  540. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
  541. </span>
  542. </div>
  543. <!-- ========== Info from phpDoc block ========= -->
  544. <p class="short-description">Constructed servlet full path URLs</p>
  545. <ul class="tags">
  546. <li><span class="field">access:</span> protected</li>
  547. </ul>
  548. </div>
  549. <a name="var$_port" id="$_port"><!-- --></A>
  550. <div class="evenrow">
  551. <div class="var-header">
  552. <span class="var-title">
  553. <span class="var-type">mixed</span>
  554. <span class="var-name">$_port</span>
  555. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
  556. </span>
  557. </div>
  558. <!-- ========== Info from phpDoc block ========= -->
  559. <ul class="tags">
  560. <li><span class="field">access:</span> protected</li>
  561. </ul>
  562. </div>
  563. <a name="var$_queryBracketsEscaped" id="$_queryBracketsEscaped"><!-- --></A>
  564. <div class="oddrow">
  565. <div class="var-header">
  566. <span class="var-title">
  567. <span class="var-type">mixed</span>
  568. <span class="var-name">$_queryBracketsEscaped</span>
  569. = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
  570. </span>
  571. </div>
  572. <!-- ========== Info from phpDoc block ========= -->
  573. <ul class="tags">
  574. <li><span class="field">access:</span> protected</li>
  575. </ul>
  576. </div>
  577. <a name="var$_queryDelimiter" id="$_queryDelimiter"><!-- --></A>
  578. <div class="evenrow">
  579. <div class="var-header">
  580. <span class="var-title">
  581. <span class="var-type">string</span>
  582. <span class="var-name">$_queryDelimiter</span>
  583. = <span class="var-default"> '?'</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
  584. </span>
  585. </div>
  586. <!-- ========== Info from phpDoc block ========= -->
  587. <p class="short-description">Query delimiters. Someone might want to be able to change these (to use &amp;amp; instead of &amp; for example), so I've provided them.</p>
  588. <ul class="tags">
  589. <li><span class="field">access:</span> protected</li>
  590. </ul>
  591. </div>
  592. <a name="var$_queryStringDelimiter" id="$_queryStringDelimiter"><!-- --></A>
  593. <div class="oddrow">
  594. <div class="var-header">
  595. <span class="var-title">
  596. <span class="var-type">mixed</span>
  597. <span class="var-name">$_queryStringDelimiter</span>
  598. = <span class="var-default"> '&amp;'</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
  599. </span>
  600. </div>
  601. <!-- ========== Info from phpDoc block ========= -->
  602. <ul class="tags">
  603. <li><span class="field">access:</span> protected</li>
  604. </ul>
  605. </div>
  606. <a name="var$_searchUrl" id="$_searchUrl"><!-- --></A>
  607. <div class="evenrow">
  608. <div class="var-header">
  609. <span class="var-title">
  610. <span class="var-type">mixed</span>
  611. <span class="var-name">$_searchUrl</span>
  612. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
  613. </span>
  614. </div>
  615. <!-- ========== Info from phpDoc block ========= -->
  616. <ul class="tags">
  617. <li><span class="field">access:</span> protected</li>
  618. </ul>
  619. </div>
  620. <a name="var$_threadsUrl" id="$_threadsUrl"><!-- --></A>
  621. <div class="oddrow">
  622. <div class="var-header">
  623. <span class="var-title">
  624. <span class="var-type">mixed</span>
  625. <span class="var-name">$_threadsUrl</span>
  626. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
  627. </span>
  628. </div>
  629. <!-- ========== Info from phpDoc block ========= -->
  630. <ul class="tags">
  631. <li><span class="field">access:</span> protected</li>
  632. </ul>
  633. </div>
  634. <a name="var$_updateUrl" id="$_updateUrl"><!-- --></A>
  635. <div class="evenrow">
  636. <div class="var-header">
  637. <span class="var-title">
  638. <span class="var-type">mixed</span>
  639. <span class="var-name">$_updateUrl</span>
  640. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
  641. </span>
  642. </div>
  643. <!-- ========== Info from phpDoc block ========= -->
  644. <ul class="tags">
  645. <li><span class="field">access:</span> protected</li>
  646. </ul>
  647. </div>
  648. <a name="var$_urlsInited" id="$_urlsInited"><!-- --></A>
  649. <div class="oddrow">
  650. <div class="var-header">
  651. <span class="var-title">
  652. <span class="var-type">boolean</span>
  653. <span class="var-name">$_urlsInited</span>
  654. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a175">175</a></span>)
  655. </span>
  656. </div>
  657. <!-- ========== Info from phpDoc block ========= -->
  658. <p class="short-description">Keep track of whether our URLs have been constructed</p>
  659. <ul class="tags">
  660. <li><span class="field">access:</span> protected</li>
  661. </ul>
  662. </div>
  663. </div>
  664. </div>
  665. <a name="sec-methods"></a>
  666. <div class="info-box">
  667. <div class="info-box-title">Methods</div>
  668. <div class="nav-bar">
  669. <a href="#sec-description">Description</a> |
  670. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  671. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  672. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  673. </div>
  674. <div class="info-box-body">
  675. <A NAME='method_detail'></A>
  676. <a name="methodescape" id="escape"><!-- --></a>
  677. <div class="evenrow">
  678. <div class="method-header">
  679. <span class="method-title">static escape</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a192">192</a></span>)
  680. </div>
  681. <!-- ========== Info from phpDoc block ========= -->
  682. <p class="short-description">Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.</p>
  683. <p class="description"><p>NOTE: inside a phrase fewer characters need escaped, use <a href="../../Apache/Solr/Apache_Solr_Service.html#methodescapePhrase">Apache_Solr_Service::escapePhrase()</a> instead</p></p>
  684. <ul class="tags">
  685. <li><span class="field">access:</span> public</li>
  686. </ul>
  687. <div class="method-signature">
  688. static <span class="method-result">string</span>
  689. <span class="method-name">
  690. escape
  691. </span>
  692. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  693. </div>
  694. <ul class="parameters">
  695. <li>
  696. <span class="var-type">string</span>
  697. <span class="var-name">$value</span> </li>
  698. </ul>
  699. </div>
  700. <a name="methodescapePhrase" id="escapePhrase"><!-- --></a>
  701. <div class="oddrow">
  702. <div class="method-header">
  703. <span class="method-title">static escapePhrase</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a207">207</a></span>)
  704. </div>
  705. <!-- ========== Info from phpDoc block ========= -->
  706. <p class="short-description">Escape a value meant to be contained in a phrase for special query characters</p>
  707. <ul class="tags">
  708. <li><span class="field">access:</span> public</li>
  709. </ul>
  710. <div class="method-signature">
  711. static <span class="method-result">string</span>
  712. <span class="method-name">
  713. escapePhrase
  714. </span>
  715. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  716. </div>
  717. <ul class="parameters">
  718. <li>
  719. <span class="var-type">string</span>
  720. <span class="var-name">$value</span> </li>
  721. </ul>
  722. </div>
  723. <a name="methodphrase" id="phrase"><!-- --></a>
  724. <div class="evenrow">
  725. <div class="method-header">
  726. <span class="method-title">static phrase</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a221">221</a></span>)
  727. </div>
  728. <!-- ========== Info from phpDoc block ========= -->
  729. <p class="short-description">Convenience function for creating phrase syntax from a value</p>
  730. <ul class="tags">
  731. <li><span class="field">access:</span> public</li>
  732. </ul>
  733. <div class="method-signature">
  734. static <span class="method-result">string</span>
  735. <span class="method-name">
  736. phrase
  737. </span>
  738. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  739. </div>
  740. <ul class="parameters">
  741. <li>
  742. <span class="var-type">string</span>
  743. <span class="var-name">$value</span> </li>
  744. </ul>
  745. </div>
  746. <a name="methodadd" id="add"><!-- --></a>
  747. <div class="oddrow">
  748. <div class="method-header">
  749. <span class="method-title">add</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a667">667</a></span>)
  750. </div>
  751. <!-- ========== Info from phpDoc block ========= -->
  752. <p class="short-description">Raw Add Method. Takes a raw post body and sends it to the update service. Post body should be a complete and well formed &quot;add&quot; xml document.</p>
  753. <ul class="tags">
  754. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  755. <li><span class="field">access:</span> public</li>
  756. </ul>
  757. <div class="method-signature">
  758. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  759. <span class="method-name">
  760. add
  761. </span>
  762. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>)
  763. </div>
  764. <ul class="parameters">
  765. <li>
  766. <span class="var-type">string</span>
  767. <span class="var-name">$rawPost</span> </li>
  768. </ul>
  769. </div>
  770. <a name="methodaddDocument" id="addDocument"><!-- --></a>
  771. <div class="evenrow">
  772. <div class="method-header">
  773. <span class="method-title">addDocument</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a684">684</a></span>)
  774. </div>
  775. <!-- ========== Info from phpDoc block ========= -->
  776. <p class="short-description">Add a Solr Document to the index</p>
  777. <ul class="tags">
  778. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  779. <li><span class="field">access:</span> public</li>
  780. </ul>
  781. <div class="method-signature">
  782. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  783. <span class="method-name">
  784. addDocument
  785. </span>
  786. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
  787. </div>
  788. <ul class="parameters">
  789. <li>
  790. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  791. <span class="var-name">$document</span> </li>
  792. <li>
  793. <span class="var-type">boolean</span>
  794. <span class="var-name">$allowDups</span> </li>
  795. <li>
  796. <span class="var-type">boolean</span>
  797. <span class="var-name">$overwritePending</span> </li>
  798. <li>
  799. <span class="var-type">boolean</span>
  800. <span class="var-name">$overwriteCommitted</span> </li>
  801. <li>
  802. <span class="var-type">integer</span>
  803. <span class="var-name">$commitWithin</span><span class="var-description">: The number of milliseconds that a document must be committed within, see @{link http://wiki.apache.org/solr/UpdateXmlMessages#The_Update_Schema} for details. If left empty this property will not be set in the request.</span> </li>
  804. </ul>
  805. </div>
  806. <a name="methodaddDocuments" id="addDocuments"><!-- --></a>
  807. <div class="oddrow">
  808. <div class="method-header">
  809. <span class="method-title">addDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a712">712</a></span>)
  810. </div>
  811. <!-- ========== Info from phpDoc block ========= -->
  812. <p class="short-description">Add an array of Solr Documents to the index all at once</p>
  813. <ul class="tags">
  814. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  815. <li><span class="field">access:</span> public</li>
  816. </ul>
  817. <div class="method-signature">
  818. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  819. <span class="method-name">
  820. addDocuments
  821. </span>
  822. (<span class="var-type">array</span>&nbsp;<span class="var-name">$documents</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
  823. </div>
  824. <ul class="parameters">
  825. <li>
  826. <span class="var-type">array</span>
  827. <span class="var-name">$documents</span><span class="var-description">: Should be an array of Apache_Solr_Document instances</span> </li>
  828. <li>
  829. <span class="var-type">boolean</span>
  830. <span class="var-name">$allowDups</span> </li>
  831. <li>
  832. <span class="var-type">boolean</span>
  833. <span class="var-name">$overwritePending</span> </li>
  834. <li>
  835. <span class="var-type">boolean</span>
  836. <span class="var-name">$overwriteCommitted</span> </li>
  837. <li>
  838. <span class="var-type">integer</span>
  839. <span class="var-name">$commitWithin</span><span class="var-description">: The number of milliseconds that a document must be committed within, see @{link http://wiki.apache.org/solr/UpdateXmlMessages#The_Update_Schema} for details. If left empty this property will not be set in the request.</span> </li>
  840. </ul>
  841. </div>
  842. <a name="methodcommit" id="commit"><!-- --></a>
  843. <div class="evenrow">
  844. <div class="method-header">
  845. <span class="method-title">commit</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a821">821</a></span>)
  846. </div>
  847. <!-- ========== Info from phpDoc block ========= -->
  848. <p class="short-description">Send a commit command. Will be synchronous unless both wait parameters are set to false.</p>
  849. <ul class="tags">
  850. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  851. <li><span class="field">access:</span> public</li>
  852. </ul>
  853. <div class="method-signature">
  854. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  855. <span class="method-name">
  856. commit
  857. </span>
  858. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$expungeDeletes</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  859. </div>
  860. <ul class="parameters">
  861. <li>
  862. <span class="var-type">boolean</span>
  863. <span class="var-name">$expungeDeletes</span><span class="var-description">: Defaults to false, merge segments with deletes away</span> </li>
  864. <li>
  865. <span class="var-type">boolean</span>
  866. <span class="var-name">$waitFlush</span><span class="var-description">: Defaults to true, block until index changes are flushed to disk</span> </li>
  867. <li>
  868. <span class="var-type">boolean</span>
  869. <span class="var-name">$waitSearcher</span><span class="var-description">: Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible</span> </li>
  870. <li>
  871. <span class="var-type">float</span>
  872. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour</span> </li>
  873. </ul>
  874. </div>
  875. <a name="methoddelete" id="delete"><!-- --></a>
  876. <div class="oddrow">
  877. <div class="method-header">
  878. <span class="method-title">delete</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a842">842</a></span>)
  879. </div>
  880. <!-- ========== Info from phpDoc block ========= -->
  881. <p class="short-description">Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be a complete and well formed &quot;delete&quot; xml document</p>
  882. <ul class="tags">
  883. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  884. <li><span class="field">access:</span> public</li>
  885. </ul>
  886. <div class="method-signature">
  887. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  888. <span class="method-name">
  889. delete
  890. </span>
  891. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  892. </div>
  893. <ul class="parameters">
  894. <li>
  895. <span class="var-type">string</span>
  896. <span class="var-name">$rawPost</span><span class="var-description">: Expected to be utf-8 encoded xml document</span> </li>
  897. <li>
  898. <span class="var-type">float</span>
  899. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  900. </ul>
  901. </div>
  902. <a name="methoddeleteById" id="deleteById"><!-- --></a>
  903. <div class="evenrow">
  904. <div class="method-header">
  905. <span class="method-title">deleteById</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a858">858</a></span>)
  906. </div>
  907. <!-- ========== Info from phpDoc block ========= -->
  908. <p class="short-description">Create a delete document based on document ID</p>
  909. <ul class="tags">
  910. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  911. <li><span class="field">access:</span> public</li>
  912. </ul>
  913. <div class="method-signature">
  914. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  915. <span class="method-name">
  916. deleteById
  917. </span>
  918. (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  919. </div>
  920. <ul class="parameters">
  921. <li>
  922. <span class="var-type">string</span>
  923. <span class="var-name">$id</span><span class="var-description">: Expected to be utf-8 encoded</span> </li>
  924. <li>
  925. <span class="var-type">boolean</span>
  926. <span class="var-name">$fromPending</span> </li>
  927. <li>
  928. <span class="var-type">boolean</span>
  929. <span class="var-name">$fromCommitted</span> </li>
  930. <li>
  931. <span class="var-type">float</span>
  932. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  933. </ul>
  934. </div>
  935. <a name="methoddeleteByMultipleIds" id="deleteByMultipleIds"><!-- --></a>
  936. <div class="oddrow">
  937. <div class="method-header">
  938. <span class="method-title">deleteByMultipleIds</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a882">882</a></span>)
  939. </div>
  940. <!-- ========== Info from phpDoc block ========= -->
  941. <p class="short-description">Create and post a delete document based on multiple document IDs.</p>
  942. <ul class="tags">
  943. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  944. <li><span class="field">access:</span> public</li>
  945. </ul>
  946. <div class="method-signature">
  947. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  948. <span class="method-name">
  949. deleteByMultipleIds
  950. </span>
  951. (<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  952. </div>
  953. <ul class="parameters">
  954. <li>
  955. <span class="var-type">array</span>
  956. <span class="var-name">$ids</span><span class="var-description">: Expected to be utf-8 encoded strings</span> </li>
  957. <li>
  958. <span class="var-type">boolean</span>
  959. <span class="var-name">$fromPending</span> </li>
  960. <li>
  961. <span class="var-type">boolean</span>
  962. <span class="var-name">$fromCommitted</span> </li>
  963. <li>
  964. <span class="var-type">float</span>
  965. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  966. </ul>
  967. </div>
  968. <a name="methoddeleteByQuery" id="deleteByQuery"><!-- --></a>
  969. <div class="evenrow">
  970. <div class="method-header">
  971. <span class="method-title">deleteByQuery</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a913">913</a></span>)
  972. </div>
  973. <!-- ========== Info from phpDoc block ========= -->
  974. <p class="short-description">Create a delete document based on a query and submit it</p>
  975. <ul class="tags">
  976. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  977. <li><span class="field">access:</span> public</li>
  978. </ul>
  979. <div class="method-signature">
  980. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  981. <span class="method-name">
  982. deleteByQuery
  983. </span>
  984. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  985. </div>
  986. <ul class="parameters">
  987. <li>
  988. <span class="var-type">string</span>
  989. <span class="var-name">$rawQuery</span><span class="var-description">: Expected to be utf-8 encoded</span> </li>
  990. <li>
  991. <span class="var-type">boolean</span>
  992. <span class="var-name">$fromPending</span> </li>
  993. <li>
  994. <span class="var-type">boolean</span>
  995. <span class="var-name">$fromCommitted</span> </li>
  996. <li>
  997. <span class="var-type">float</span>
  998. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  999. </ul>
  1000. </div>
  1001. <a name="methodextract" id="extract"><!-- --></a>
  1002. <div class="oddrow">
  1003. <div class="method-header">
  1004. <span class="method-title">extract</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a944">944</a></span>)
  1005. </div>
  1006. <!-- ========== Info from phpDoc block ========= -->
  1007. <p class="short-description">Use Solr Cell to extract document contents. See <a href="http://wiki.apache.org/solr/ExtractingRequestHandler">http://wiki.apache.org/solr/ExtractingRequestHandler</a> for information on how to use Solr Cell and what parameters are available.</p>
  1008. <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by &quot;literal.&quot; and &quot;boost.&quot; as appropriate. Any keys from the $params array will NOT be treated this way. Any mappings from the document will overwrite key / value pairs in the params array if they have the same name (e.g. you pass a &quot;literal.id&quot; key and value in your $params array but you also pass in a document isntance with an &quot;id&quot; field&quot; - the document's value(s) will take precedence).</p></p>
  1009. <ul class="tags">
  1010. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
  1011. <li><span class="field">access:</span> public</li>
  1012. </ul>
  1013. <div class="method-signature">
  1014. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1015. <span class="method-name">
  1016. extract
  1017. </span>
  1018. (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  1019. </div>
  1020. <ul class="parameters">
  1021. <li>
  1022. <span class="var-type">string</span>
  1023. <span class="var-name">$file</span><span class="var-description">: Path to file to extract data from</span> </li>
  1024. <li>
  1025. <span class="var-type">array</span>
  1026. <span class="var-name">$params</span><span class="var-description">: optional array of key value pairs that will be sent with the post (see Solr Cell documentation)</span> </li>
  1027. <li>
  1028. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  1029. <span class="var-name">$document</span><span class="var-description">: optional document that will be used to generate post parameters (literal.* and boost.* params)</span> </li>
  1030. <li>
  1031. <span class="var-type">string</span>
  1032. <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
  1033. </ul>
  1034. </div>
  1035. <a name="methodextractFromString" id="extractFromString"><!-- --></a>
  1036. <div class="evenrow">
  1037. <div class="method-header">
  1038. <span class="method-title">extractFromString</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1005">1005</a></span>)
  1039. </div>
  1040. <!-- ========== Info from phpDoc block ========= -->
  1041. <p class="short-description">Use Solr Cell to extract document contents. See <a href="http://wiki.apache.org/solr/ExtractingRequestHandler">http://wiki.apache.org/solr/ExtractingRequestHandler</a> for information on how to use Solr Cell and what parameters are available.</p>
  1042. <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by &quot;literal.&quot; and &quot;boost.&quot; as appropriate. Any keys from the $params array will NOT be treated this way. Any mappings from the document will overwrite key / value pairs in the params array if they have the same name (e.g. you pass a &quot;literal.id&quot; key and value in your $params array but you also pass in a document isntance with an &quot;id&quot; field&quot; - the document's value(s) will take precedence).</p></p>
  1043. <ul class="tags">
  1044. <li><span class="field">todo:</span> Should be using multipart/form-data to post parameter values, but I could not get my implementation to work. Needs revisisted.</li>
  1045. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
  1046. <li><span class="field">access:</span> public</li>
  1047. </ul>
  1048. <div class="method-signature">
  1049. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1050. <span class="method-name">
  1051. extractFromString
  1052. </span>
  1053. (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  1054. </div>
  1055. <ul class="parameters">
  1056. <li>
  1057. <span class="var-type">string</span>
  1058. <span class="var-name">$data</span><span class="var-description">: Data that will be passed to Solr Cell</span> </li>
  1059. <li>
  1060. <span class="var-type">array</span>
  1061. <span class="var-name">$params</span><span class="var-description">: optional array of key value pairs that will be sent with the post (see Solr Cell documentation)</span> </li>
  1062. <li>
  1063. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  1064. <span class="var-name">$document</span><span class="var-description">: optional document that will be used to generate post parameters (literal.* and boost.* params)</span> </li>
  1065. <li>
  1066. <span class="var-type">string</span>
  1067. <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
  1068. </ul>
  1069. </div>
  1070. <a name="methodextractFromUrl" id="extractFromUrl"><!-- --></a>
  1071. <div class="oddrow">
  1072. <div class="method-header">
  1073. <span class="method-title">extractFromUrl</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1068">1068</a></span>)
  1074. </div>
  1075. <!-- ========== Info from phpDoc block ========= -->
  1076. <p class="short-description">Use Solr Cell to extract document contents. See <a href="http://wiki.apache.org/solr/ExtractingRequestHandler">http://wiki.apache.org/solr/ExtractingRequestHandler</a> for information on how to use Solr Cell and what parameters are available.</p>
  1077. <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by &quot;literal.&quot; and &quot;boost.&quot; as appropriate. Any keys from the $params array will NOT be treated this way. Any mappings from the document will overwrite key / value pairs in the params array if they have the same name (e.g. you pass a &quot;literal.id&quot; key and value in your $params array but you also pass in a document isntance with an &quot;id&quot; field&quot; - the document's value(s) will take precedence).</p></p>
  1078. <ul class="tags">
  1079. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $url, $params, or $document are invalid.</li>
  1080. <li><span class="field">access:</span> public</li>
  1081. </ul>
  1082. <div class="method-signature">
  1083. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1084. <span class="method-name">
  1085. extractFromUrl
  1086. </span>
  1087. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  1088. </div>
  1089. <ul class="parameters">
  1090. <li>
  1091. <span class="var-type">string</span>
  1092. <span class="var-name">$url</span><span class="var-description">: URL</span> </li>
  1093. <li>
  1094. <span class="var-type">array</span>
  1095. <span class="var-name">$params</span><span class="var-description">: optional array of key value pairs that will be sent with the post (see Solr Cell documentation)</span> </li>
  1096. <li>
  1097. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  1098. <span class="var-name">$document</span><span class="var-description">: optional document that will be used to generate post parameters (literal.* and boost.* params)</span> </li>
  1099. <li>
  1100. <span class="var-type">string</span>
  1101. <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
  1102. </ul>
  1103. </div>
  1104. <a name="methodgetCollapseSingleValueArrays" id="getCollapseSingleValueArrays"><!-- --></a>
  1105. <div class="evenrow">
  1106. <div class="method-header">
  1107. <span class="method-title">getCollapseSingleValueArrays</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a533">533</a></span>)
  1108. </div>
  1109. <!-- ========== Info from phpDoc block ========= -->
  1110. <p class="short-description">Get the current state of the collapse single value arrays flag.</p>
  1111. <ul class="tags">
  1112. <li><span class="field">access:</span> public</li>
  1113. </ul>
  1114. <div class="method-signature">
  1115. <span class="method-result">boolean</span>
  1116. <span class="method-name">
  1117. getCollapseSingleValueArrays
  1118. </span>
  1119. ()
  1120. </div>
  1121. </div>
  1122. <a name="methodgetCreateDocuments" id="getCreateDocuments"><!-- --></a>
  1123. <div class="oddrow">
  1124. <div class="method-header">
  1125. <span class="method-title">getCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a513">513</a></span>)
  1126. </div>
  1127. <!-- ========== Info from phpDoc block ========= -->
  1128. <p class="short-description">Get the current state of teh create documents flag.</p>
  1129. <ul class="tags">
  1130. <li><span class="field">access:</span> public</li>
  1131. </ul>
  1132. <div class="method-signature">
  1133. <span class="method-result">boolean</span>
  1134. <span class="method-name">
  1135. getCreateDocuments
  1136. </span>
  1137. ()
  1138. </div>
  1139. </div>
  1140. <a name="methodgetDefaultTimeout" id="getDefaultTimeout"><!-- --></a>
  1141. <div class="evenrow">
  1142. <div class="method-header">
  1143. <span class="method-title">getDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a546">546</a></span>)
  1144. </div>
  1145. <!-- ========== Info from phpDoc block ========= -->
  1146. <p class="short-description">Get the current default timeout setting (initially the default_socket_timeout ini setting) in seconds</p>
  1147. <ul class="tags">
  1148. <li><span class="field">deprecated:</span> Use the getDefaultTimeout method on the HTTP transport implementation</li>
  1149. <li><span class="field">access:</span> public</li>
  1150. </ul>
  1151. <div class="method-signature">
  1152. <span class="method-result">float</span>
  1153. <span class="method-name">
  1154. getDefaultTimeout
  1155. </span>
  1156. ()
  1157. </div>
  1158. </div>
  1159. <a name="methodgetHost" id="getHost"><!-- --></a>
  1160. <div class="oddrow">
  1161. <div class="method-header">
  1162. <span class="method-title">getHost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a375">375</a></span>)
  1163. </div>
  1164. <!-- ========== Info from phpDoc block ========= -->
  1165. <p class="short-description">Returns the set host</p>
  1166. <ul class="tags">
  1167. <li><span class="field">access:</span> public</li>
  1168. </ul>
  1169. <div class="method-signature">
  1170. <span class="method-result">string</span>
  1171. <span class="method-name">
  1172. getHost
  1173. </span>
  1174. ()
  1175. </div>
  1176. </div>
  1177. <a name="methodgetHttpTransport" id="getHttpTransport"><!-- --></a>
  1178. <div class="evenrow">
  1179. <div class="method-header">
  1180. <span class="method-title">getHttpTransport</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a474">474</a></span>)
  1181. </div>
  1182. <!-- ========== Info from phpDoc block ========= -->
  1183. <p class="short-description">Get the current configured HTTP Transport</p>
  1184. <ul class="tags">
  1185. <li><span class="field">access:</span> public</li>
  1186. </ul>
  1187. <div class="method-signature">
  1188. <span class="method-result">HttpTransportInterface</span>
  1189. <span class="method-name">
  1190. getHttpTransport
  1191. </span>
  1192. ()
  1193. </div>
  1194. </div>
  1195. <a name="methodgetNamedListTreatment" id="getNamedListTreatment"><!-- --></a>
  1196. <div class="oddrow">
  1197. <div class="method-header">
  1198. <span class="method-title">getNamedListTreatment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a592">592</a></span>)
  1199. </div>
  1200. <!-- ========== Info from phpDoc block ========= -->
  1201. <p class="short-description">Get the current setting for named list treatment.</p>
  1202. <ul class="tags">
  1203. <li><span class="field">access:</span> public</li>
  1204. </ul>
  1205. <div class="method-signature">
  1206. <span class="method-result">string</span>
  1207. <span class="method-name">
  1208. getNamedListTreatment
  1209. </span>
  1210. ()
  1211. </div>
  1212. </div>
  1213. <a name="methodgetPath" id="getPath"><!-- --></a>
  1214. <div class="evenrow">
  1215. <div class="method-header">
  1216. <span class="method-title">getPath</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a447">447</a></span>)
  1217. </div>
  1218. <!-- ========== Info from phpDoc block ========= -->
  1219. <p class="short-description">Get the set path.</p>
  1220. <ul class="tags">
  1221. <li><span class="field">access:</span> public</li>
  1222. </ul>
  1223. <div class="method-signature">
  1224. <span class="method-result">string</span>
  1225. <span class="method-name">
  1226. getPath
  1227. </span>
  1228. ()
  1229. </div>
  1230. </div>
  1231. <a name="methodgetPort" id="getPort"><!-- --></a>
  1232. <div class="oddrow">
  1233. <div class="method-header">
  1234. <span class="method-title">getPort</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a410">410</a></span>)
  1235. </div>
  1236. <!-- ========== Info from phpDoc block ========= -->
  1237. <p class="short-description">Get the set port</p>
  1238. <ul class="tags">
  1239. <li><span class="field">access:</span> public</li>
  1240. </ul>
  1241. <div class="method-signature">
  1242. <span class="method-result">integer</span>
  1243. <span class="method-name">
  1244. getPort
  1245. </span>
  1246. ()
  1247. </div>
  1248. </div>
  1249. <a name="method__construct" id="__construct"><!-- --></a>
  1250. <div class="evenrow">
  1251. <div class="method-header">
  1252. <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a235">235</a></span>)
  1253. </div>
  1254. <!-- ========== Info from phpDoc block ========= -->
  1255. <p class="short-description">Constructor. All parameters are optional and will take on default values if not specified.</p>
  1256. <ul class="tags">
  1257. <li><span class="field">access:</span> public</li>
  1258. </ul>
  1259. <div class="method-signature">
  1260. <span class="method-result">Apache_Solr_Service</span>
  1261. <span class="method-name">
  1262. __construct
  1263. </span>
  1264. ([<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">'localhost'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">8180</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">'/solr/'</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>&nbsp;<span class="var-name">$httpTransport</span> = <span class="var-default">false</span>])
  1265. </div>
  1266. <ul class="parameters">
  1267. <li>
  1268. <span class="var-type">string</span>
  1269. <span class="var-name">$host</span> </li>
  1270. <li>
  1271. <span class="var-type">string</span>
  1272. <span class="var-name">$port</span> </li>
  1273. <li>
  1274. <span class="var-type">string</span>
  1275. <span class="var-name">$path</span> </li>
  1276. <li>
  1277. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
  1278. <span class="var-name">$httpTransport</span> </li>
  1279. </ul>
  1280. </div>
  1281. <a name="methodoptimize" id="optimize"><!-- --></a>
  1282. <div class="oddrow">
  1283. <div class="method-header">
  1284. <span class="method-title">optimize</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1117">1117</a></span>)
  1285. </div>
  1286. <!-- ========== Info from phpDoc block ========= -->
  1287. <p class="short-description">Send an optimize command. Will be synchronous unless both wait parameters are set to false.</p>
  1288. <ul class="tags">
  1289. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  1290. <li><span class="field">access:</span> public</li>
  1291. </ul>
  1292. <div class="method-signature">
  1293. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1294. <span class="method-name">
  1295. optimize
  1296. </span>
  1297. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  1298. </div>
  1299. <ul class="parameters">
  1300. <li>
  1301. <span class="var-type">boolean</span>
  1302. <span class="var-name">$waitFlush</span> </li>
  1303. <li>
  1304. <span class="var-type">boolean</span>
  1305. <span class="var-name">$waitSearcher</span> </li>
  1306. <li>
  1307. <span class="var-type">float</span>
  1308. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception)</span> </li>
  1309. </ul>
  1310. </div>
  1311. <a name="methodping" id="ping"><!-- --></a>
  1312. <div class="evenrow">
  1313. <div class="method-header">
  1314. <span class="method-title">ping</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a626">626</a></span>)
  1315. </div>
  1316. <!-- ========== Info from phpDoc block ========= -->
  1317. <p class="short-description">Call the /admin/ping servlet, can be used to quickly tell if a connection to the server is able to be made.</p>
  1318. <ul class="tags">
  1319. <li><span class="field">return:</span> Actual time taken to ping the server, FALSE if timeout or HTTP error status occurs</li>
  1320. <li><span class="field">access:</span> public</li>
  1321. </ul>
  1322. <div class="method-signature">
  1323. <span class="method-result">float</span>
  1324. <span class="method-name">
  1325. ping
  1326. </span>
  1327. ([<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">2</span>])
  1328. </div>
  1329. <ul class="parameters">
  1330. <li>
  1331. <span class="var-type">float</span>
  1332. <span class="var-name">$timeout</span><span class="var-description">: maximum time to wait for ping in seconds, -1 for unlimited (default is 2)</span> </li>
  1333. </ul>
  1334. </div>
  1335. <a name="methodsearch" id="search"><!-- --></a>
  1336. <div class="oddrow">
  1337. <div class="method-header">
  1338. <span class="method-title">search</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1140">1140</a></span>)
  1339. </div>
  1340. <!-- ========== Info from phpDoc block ========= -->
  1341. <p class="short-description">Simple Search interface</p>
  1342. <ul class="tags">
  1343. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If an invalid HTTP method is used</li>
  1344. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  1345. <li><span class="field">access:</span> public</li>
  1346. </ul>
  1347. <div class="method-signature">
  1348. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1349. <span class="method-name">
  1350. search
  1351. </span>
  1352. (<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">self::METHOD_GET</span>])
  1353. </div>
  1354. <ul class="parameters">
  1355. <li>
  1356. <span class="var-type">string</span>
  1357. <span class="var-name">$query</span><span class="var-description">: The raw query string</span> </li>
  1358. <li>
  1359. <span class="var-type">int</span>
  1360. <span class="var-name">$offset</span><span class="var-description">: The starting offset for result documents</span> </li>
  1361. <li>
  1362. <span class="var-type">int</span>
  1363. <span class="var-name">$limit</span><span class="var-description">: The maximum number of result documents to return</span> </li>
  1364. <li>
  1365. <span class="var-type">array</span>
  1366. <span class="var-name">$params</span><span class="var-description">: key / value pairs for other query parameters (see Solr documentation), use arrays for parameter keys used more than once (e.g. facet.field)</span> </li>
  1367. <li>
  1368. <span class="var-type">string</span>
  1369. <span class="var-name">$method</span><span class="var-description">: The HTTP method (Apache_Solr_Service::METHOD_GET or Apache_Solr_Service::METHOD::POST)</span> </li>
  1370. </ul>
  1371. </div>
  1372. <a name="methodsetCollapseSingleValueArrays" id="setCollapseSingleValueArrays"><!-- --></a>
  1373. <div class="evenrow">
  1374. <div class="method-header">
  1375. <span class="method-title">setCollapseSingleValueArrays</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a523">523</a></span>)
  1376. </div>
  1377. <!-- ========== Info from phpDoc block ========= -->
  1378. <p class="short-description">Set the collapse single value arrays flag.</p>
  1379. <ul class="tags">
  1380. <li><span class="field">access:</span> public</li>
  1381. </ul>
  1382. <div class="method-signature">
  1383. <span class="method-result">void</span>
  1384. <span class="method-name">
  1385. setCollapseSingleValueArrays
  1386. </span>
  1387. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapseSingleValueArrays</span>)
  1388. </div>
  1389. <ul class="parameters">
  1390. <li>
  1391. <span class="var-type">boolean</span>
  1392. <span class="var-name">$collapseSingleValueArrays</span> </li>
  1393. </ul>
  1394. </div>
  1395. <a name="methodsetCreateDocuments" id="setCreateDocuments"><!-- --></a>
  1396. <div class="oddrow">
  1397. <div class="method-header">
  1398. <span class="method-title">setCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a503">503</a></span>)
  1399. </div>
  1400. <!-- ========== Info from phpDoc block ========= -->
  1401. <p class="short-description">Set the create documents flag. This determines whether <a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a> objects will parse the response and create <a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a> instances in place.</p>
  1402. <ul class="tags">
  1403. <li><span class="field">access:</span> public</li>
  1404. </ul>
  1405. <div class="method-signature">
  1406. <span class="method-result">void</span>
  1407. <span class="method-name">
  1408. setCreateDocuments
  1409. </span>
  1410. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createDocuments</span>)
  1411. </div>
  1412. <ul class="parameters">
  1413. <li>
  1414. <span class="var-type">boolean</span>
  1415. <span class="var-name">$createDocuments</span> </li>
  1416. </ul>
  1417. </div>
  1418. <a name="methodsetDefaultTimeout" id="setDefaultTimeout"><!-- --></a>
  1419. <div class="evenrow">
  1420. <div class="method-header">
  1421. <span class="method-title">setDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a558">558</a></span>)
  1422. </div>
  1423. <!-- ========== Info from phpDoc block ========= -->
  1424. <p class="short-description">Set the default timeout for all calls that aren't passed a specific timeout</p>
  1425. <ul class="tags">
  1426. <li><span class="field">deprecated:</span> Use the setDefaultTimeout method on the HTTP transport implementation</li>
  1427. <li><span class="field">access:</span> public</li>
  1428. </ul>
  1429. <div class="method-signature">
  1430. <span class="method-result">void</span>
  1431. <span class="method-name">
  1432. setDefaultTimeout
  1433. </span>
  1434. (<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
  1435. </div>
  1436. <ul class="parameters">
  1437. <li>
  1438. <span class="var-type">float</span>
  1439. <span class="var-name">$timeout</span><span class="var-description">: Timeout value in seconds</span> </li>
  1440. </ul>
  1441. </div>
  1442. <a name="methodsetHost" id="setHost"><!-- --></a>
  1443. <div class="oddrow">
  1444. <div class="method-header">
  1445. <span class="method-title">setHost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a387">387</a></span>)
  1446. </div>
  1447. <!-- ========== Info from phpDoc block ========= -->
  1448. <p class="short-description">Set the host used. If empty will fallback to constants</p>
  1449. <ul class="tags">
  1450. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If the host parameter is empty</li>
  1451. <li><span class="field">access:</span> public</li>
  1452. </ul>
  1453. <div class="method-signature">
  1454. <span class="method-result">void</span>
  1455. <span class="method-name">
  1456. setHost
  1457. </span>
  1458. (<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>)
  1459. </div>
  1460. <ul class="parameters">
  1461. <li>
  1462. <span class="var-type">string</span>
  1463. <span class="var-name">$host</span> </li>
  1464. </ul>
  1465. </div>
  1466. <a name="methodsetHttpTransport" id="setHttpTransport"><!-- --></a>
  1467. <div class="evenrow">
  1468. <div class="method-header">
  1469. <span class="method-title">setHttpTransport</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a492">492</a></span>)
  1470. </div>
  1471. <!-- ========== Info from phpDoc block ========= -->
  1472. <p class="short-description">Set the HTTP Transport implemenation that will be used for all HTTP requests</p>
  1473. <ul class="tags">
  1474. <li><span class="field">access:</span> public</li>
  1475. </ul>
  1476. <div class="method-signature">
  1477. <span class="method-result">void</span>
  1478. <span class="method-name">
  1479. setHttpTransport
  1480. </span>
  1481. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>&nbsp;<span class="var-name">$httpTransport</span>)
  1482. </div>
  1483. <ul class="parameters">
  1484. <li>
  1485. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
  1486. <span class="var-name">$httpTransport</span> </li>
  1487. </ul>
  1488. </div>
  1489. <a name="methodsetNamedListTreatment" id="setNamedListTreatment"><!-- --></a>
  1490. <div class="oddrow">
  1491. <div class="method-header">
  1492. <span class="method-title">setNamedListTreatment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a570">570</a></span>)
  1493. </div>
  1494. <!-- ========== Info from phpDoc block ========= -->
  1495. <p class="short-description">Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.</p>
  1496. <ul class="tags">
  1497. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If invalid option is set</li>
  1498. <li><span class="field">access:</span> public</li>
  1499. </ul>
  1500. <div class="method-signature">
  1501. <span class="method-result">void</span>
  1502. <span class="method-name">
  1503. setNamedListTreatment
  1504. </span>
  1505. (<span class="var-type">string</span>&nbsp;<span class="var-name">$namedListTreatment</span>)
  1506. </div>
  1507. <ul class="parameters">
  1508. <li>
  1509. <span class="var-type">string</span>
  1510. <span class="var-name">$namedListTreatment</span> </li>
  1511. </ul>
  1512. </div>
  1513. <a name="methodsetPath" id="setPath"><!-- --></a>
  1514. <div class="evenrow">
  1515. <div class="method-header">
  1516. <span class="method-title">setPath</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a457">457</a></span>)
  1517. </div>
  1518. <!-- ========== Info from phpDoc block ========= -->
  1519. <p class="short-description">Set the path used. If empty will fallback to constants</p>
  1520. <ul class="tags">
  1521. <li><span class="field">access:</span> public</li>
  1522. </ul>
  1523. <div class="method-signature">
  1524. <span class="method-result">void</span>
  1525. <span class="method-name">
  1526. setPath
  1527. </span>
  1528. (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
  1529. </div>
  1530. <ul class="parameters">
  1531. <li>
  1532. <span class="var-type">string</span>
  1533. <span class="var-name">$path</span> </li>
  1534. </ul>
  1535. </div>
  1536. <a name="methodsetPort" id="setPort"><!-- --></a>
  1537. <div class="oddrow">
  1538. <div class="method-header">
  1539. <span class="method-title">setPort</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a422">422</a></span>)
  1540. </div>
  1541. <!-- ========== Info from phpDoc block ========= -->
  1542. <p class="short-description">Set the port used. If empty will fallback to constants</p>
  1543. <ul class="tags">
  1544. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If the port parameter is empty</li>
  1545. <li><span class="field">access:</span> public</li>
  1546. </ul>
  1547. <div class="method-signature">
  1548. <span class="method-result">void</span>
  1549. <span class="method-name">
  1550. setPort
  1551. </span>
  1552. (<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
  1553. </div>
  1554. <ul class="parameters">
  1555. <li>
  1556. <span class="var-type">integer</span>
  1557. <span class="var-name">$port</span> </li>
  1558. </ul>
  1559. </div>
  1560. <a name="methodsetQueryDelimiter" id="setQueryDelimiter"><!-- --></a>
  1561. <div class="evenrow">
  1562. <div class="method-header">
  1563. <span class="method-title">setQueryDelimiter</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a603">603</a></span>)
  1564. </div>
  1565. <!-- ========== Info from phpDoc block ========= -->
  1566. <p class="short-description">Set the string used to separate the path form the query string.</p>
  1567. <p class="description"><p>Defaulted to '?'</p></p>
  1568. <ul class="tags">
  1569. <li><span class="field">access:</span> public</li>
  1570. </ul>
  1571. <div class="method-signature">
  1572. <span class="method-result">void</span>
  1573. <span class="method-name">
  1574. setQueryDelimiter
  1575. </span>
  1576. (<span class="var-type">string</span>&nbsp;<span class="var-name">$queryDelimiter</span>)
  1577. </div>
  1578. <ul class="parameters">
  1579. <li>
  1580. <span class="var-type">string</span>
  1581. <span class="var-name">$queryDelimiter</span> </li>
  1582. </ul>
  1583. </div>
  1584. <a name="methodsetQueryStringDelimiter" id="setQueryStringDelimiter"><!-- --></a>
  1585. <div class="oddrow">
  1586. <div class="method-header">
  1587. <span class="method-title">setQueryStringDelimiter</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a614">614</a></span>)
  1588. </div>
  1589. <!-- ========== Info from phpDoc block ========= -->
  1590. <p class="short-description">Set the string used to separate the parameters in thequery string Defaulted to '&amp;'</p>
  1591. <ul class="tags">
  1592. <li><span class="field">access:</span> public</li>
  1593. </ul>
  1594. <div class="method-signature">
  1595. <span class="method-result">void</span>
  1596. <span class="method-name">
  1597. setQueryStringDelimiter
  1598. </span>
  1599. (<span class="var-type">string</span>&nbsp;<span class="var-name">$queryStringDelimiter</span>)
  1600. </div>
  1601. <ul class="parameters">
  1602. <li>
  1603. <span class="var-type">string</span>
  1604. <span class="var-name">$queryStringDelimiter</span> </li>
  1605. </ul>
  1606. </div>
  1607. <a name="methodthreads" id="threads"><!-- --></a>
  1608. <div class="evenrow">
  1609. <div class="method-header">
  1610. <span class="method-title">threads</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a653">653</a></span>)
  1611. </div>
  1612. <!-- ========== Info from phpDoc block ========= -->
  1613. <p class="short-description">Call the /admin/threads servlet and retrieve information about all threads in the Solr servlet's thread group. Useful for diagnostics.</p>
  1614. <ul class="tags">
  1615. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  1616. <li><span class="field">access:</span> public</li>
  1617. </ul>
  1618. <div class="method-signature">
  1619. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1620. <span class="method-name">
  1621. threads
  1622. </span>
  1623. ()
  1624. </div>
  1625. </div>
  1626. <a name="method_constructUrl" id="_constructUrl"><!-- --></a>
  1627. <div class="oddrow">
  1628. <div class="method-header">
  1629. <span class="method-title">_constructUrl</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a258">258</a></span>)
  1630. </div>
  1631. <!-- ========== Info from phpDoc block ========= -->
  1632. <p class="short-description">Return a valid http URL given this server's host, port and path and a provided servlet name</p>
  1633. <ul class="tags">
  1634. <li><span class="field">access:</span> protected</li>
  1635. </ul>
  1636. <div class="method-signature">
  1637. <span class="method-result">string</span>
  1638. <span class="method-name">
  1639. _constructUrl
  1640. </span>
  1641. (<span class="var-type">string</span>&nbsp;<span class="var-name">$servlet</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
  1642. </div>
  1643. <ul class="parameters">
  1644. <li>
  1645. <span class="var-type">string</span>
  1646. <span class="var-name">$servlet</span> </li>
  1647. <li>
  1648. <span class="var-type"></span>
  1649. <span class="var-name">$params</span> </li>
  1650. </ul>
  1651. </div>
  1652. <a name="method_documentToXmlFragment" id="_documentToXmlFragment"><!-- --></a>
  1653. <div class="evenrow">
  1654. <div class="method-header">
  1655. <span class="method-title">_documentToXmlFragment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a741">741</a></span>)
  1656. </div>
  1657. <!-- ========== Info from phpDoc block ========= -->
  1658. <p class="short-description">Create an XML fragment from a <a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a> instance appropriate for use inside a Solr add call</p>
  1659. <ul class="tags">
  1660. <li><span class="field">access:</span> protected</li>
  1661. </ul>
  1662. <div class="method-signature">
  1663. <span class="method-result">string</span>
  1664. <span class="method-name">
  1665. _documentToXmlFragment
  1666. </span>
  1667. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>)
  1668. </div>
  1669. <ul class="parameters">
  1670. <li>
  1671. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  1672. <span class="var-name">$document</span> </li>
  1673. </ul>
  1674. </div>
  1675. <a name="method_generateQueryString" id="_generateQueryString"><!-- --></a>
  1676. <div class="oddrow">
  1677. <div class="method-header">
  1678. <span class="method-title">_generateQueryString</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a295">295</a></span>)
  1679. </div>
  1680. <!-- ========== Info from phpDoc block ========= -->
  1681. <ul class="tags">
  1682. <li><span class="field">access:</span> protected</li>
  1683. </ul>
  1684. <div class="method-signature">
  1685. <span class="method-result">void</span>
  1686. <span class="method-name">
  1687. _generateQueryString
  1688. </span>
  1689. (<span class="var-type"></span>&nbsp;<span class="var-name">$params</span>)
  1690. </div>
  1691. <ul class="parameters">
  1692. <li>
  1693. <span class="var-type"></span>
  1694. <span class="var-name">$params</span> </li>
  1695. </ul>
  1696. </div>
  1697. <a name="method_initUrls" id="_initUrls"><!-- --></a>
  1698. <div class="evenrow">
  1699. <div class="method-header">
  1700. <span class="method-title">_initUrls</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a283">283</a></span>)
  1701. </div>
  1702. <!-- ========== Info from phpDoc block ========= -->
  1703. <p class="short-description">Construct the Full URLs for the three servlets we reference</p>
  1704. <ul class="tags">
  1705. <li><span class="field">access:</span> protected</li>
  1706. </ul>
  1707. <div class="method-signature">
  1708. <span class="method-result">void</span>
  1709. <span class="method-name">
  1710. _initUrls
  1711. </span>
  1712. ()
  1713. </div>
  1714. </div>
  1715. <a name="method_sendRawGet" id="_sendRawGet"><!-- --></a>
  1716. <div class="oddrow">
  1717. <div class="method-header">
  1718. <span class="method-title">_sendRawGet</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a329">329</a></span>)
  1719. </div>
  1720. <!-- ========== Info from phpDoc block ========= -->
  1721. <p class="short-description">Central method for making a get operation against this Solr Server</p>
  1722. <ul class="tags">
  1723. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If a non 200 response status is returned</li>
  1724. <li><span class="field">access:</span> protected</li>
  1725. </ul>
  1726. <div class="method-signature">
  1727. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1728. <span class="method-name">
  1729. _sendRawGet
  1730. </span>
  1731. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>])
  1732. </div>
  1733. <ul class="parameters">
  1734. <li>
  1735. <span class="var-type">string</span>
  1736. <span class="var-name">$url</span> </li>
  1737. <li>
  1738. <span class="var-type">float</span>
  1739. <span class="var-name">$timeout</span><span class="var-description">: Read timeout in seconds</span> </li>
  1740. </ul>
  1741. </div>
  1742. <a name="method_sendRawPost" id="_sendRawPost"><!-- --></a>
  1743. <div class="evenrow">
  1744. <div class="method-header">
  1745. <span class="method-title">_sendRawPost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a355">355</a></span>)
  1746. </div>
  1747. <!-- ========== Info from phpDoc block ========= -->
  1748. <p class="short-description">Central method for making a post operation against this Solr Server</p>
  1749. <ul class="tags">
  1750. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If a non 200 response status is returned</li>
  1751. <li><span class="field">access:</span> protected</li>
  1752. </ul>
  1753. <div class="method-signature">
  1754. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1755. <span class="method-name">
  1756. _sendRawPost
  1757. </span>
  1758. (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span> = <span class="var-default">'text/xml; charset=UTF-8'</span>])
  1759. </div>
  1760. <ul class="parameters">
  1761. <li>
  1762. <span class="var-type">string</span>
  1763. <span class="var-name">$url</span> </li>
  1764. <li>
  1765. <span class="var-type">string</span>
  1766. <span class="var-name">$rawPost</span> </li>
  1767. <li>
  1768. <span class="var-type">float</span>
  1769. <span class="var-name">$timeout</span><span class="var-description">: Read timeout in seconds</span> </li>
  1770. <li>
  1771. <span class="var-type">string</span>
  1772. <span class="var-name">$contentType</span> </li>
  1773. </ul>
  1774. </div>
  1775. <a name="method_stripCtrlChars" id="_stripCtrlChars"><!-- --></a>
  1776. <div class="oddrow">
  1777. <div class="method-header">
  1778. <span class="method-title">_stripCtrlChars</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a803">803</a></span>)
  1779. </div>
  1780. <!-- ========== Info from phpDoc block ========= -->
  1781. <p class="short-description">Replace control (non-printable) characters from string that are invalid to Solr's XML parser with a space.</p>
  1782. <ul class="tags">
  1783. <li><span class="field">access:</span> protected</li>
  1784. </ul>
  1785. <div class="method-signature">
  1786. <span class="method-result">string</span>
  1787. <span class="method-name">
  1788. _stripCtrlChars
  1789. </span>
  1790. (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  1791. </div>
  1792. <ul class="parameters">
  1793. <li>
  1794. <span class="var-type">string</span>
  1795. <span class="var-name">$string</span> </li>
  1796. </ul>
  1797. </div>
  1798. </div>
  1799. </div>
  1800. <a name="sec-consts"></a>
  1801. <div class="info-box">
  1802. <div class="info-box-title">Class Constants</div>
  1803. <div class="nav-bar">
  1804. <a href="#sec-description">Description</a> |
  1805. <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
  1806. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  1807. |
  1808. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  1809. </div>
  1810. <div class="info-box-body">
  1811. <a name="constEXTRACT_SERVLET" id="EXTRACT_SERVLET"><!-- --></A>
  1812. <div class="evenrow">
  1813. <div class="const-header">
  1814. <img src="../../media/images/Variable.png" />
  1815. <span class="const-title">
  1816. <span class="const-name">EXTRACT_SERVLET</span>
  1817. = <span class="const-default"> 'update/extract'</span>
  1818. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a122">122</a></span>)
  1819. </span>
  1820. </div>
  1821. <!-- ========== Info from phpDoc block ========= -->
  1822. </div>
  1823. <a name="constMETHOD_GET" id="METHOD_GET"><!-- --></A>
  1824. <div class="oddrow">
  1825. <div class="const-header">
  1826. <img src="../../media/images/Variable.png" />
  1827. <span class="const-title">
  1828. <span class="const-name">METHOD_GET</span>
  1829. = <span class="const-default"> 'GET'</span>
  1830. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a112">112</a></span>)
  1831. </span>
  1832. </div>
  1833. <!-- ========== Info from phpDoc block ========= -->
  1834. <p class="short-description">Search HTTP Methods</p>
  1835. </div>
  1836. <a name="constMETHOD_POST" id="METHOD_POST"><!-- --></A>
  1837. <div class="evenrow">
  1838. <div class="const-header">
  1839. <img src="../../media/images/Variable.png" />
  1840. <span class="const-title">
  1841. <span class="const-name">METHOD_POST</span>
  1842. = <span class="const-default"> 'POST'</span>
  1843. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a113">113</a></span>)
  1844. </span>
  1845. </div>
  1846. <!-- ========== Info from phpDoc block ========= -->
  1847. </div>
  1848. <a name="constNAMED_LIST_FLAT" id="NAMED_LIST_FLAT"><!-- --></A>
  1849. <div class="oddrow">
  1850. <div class="const-header">
  1851. <img src="../../media/images/Variable.png" />
  1852. <span class="const-title">
  1853. <span class="const-name">NAMED_LIST_FLAT</span>
  1854. = <span class="const-default"> 'flat'</span>
  1855. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a106">106</a></span>)
  1856. </span>
  1857. </div>
  1858. <!-- ========== Info from phpDoc block ========= -->
  1859. <p class="short-description">NamedList Treatment constants</p>
  1860. </div>
  1861. <a name="constNAMED_LIST_MAP" id="NAMED_LIST_MAP"><!-- --></A>
  1862. <div class="evenrow">
  1863. <div class="const-header">
  1864. <img src="../../media/images/Variable.png" />
  1865. <span class="const-title">
  1866. <span class="const-name">NAMED_LIST_MAP</span>
  1867. = <span class="const-default"> 'map'</span>
  1868. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a107">107</a></span>)
  1869. </span>
  1870. </div>
  1871. <!-- ========== Info from phpDoc block ========= -->
  1872. </div>
  1873. <a name="constPING_SERVLET" id="PING_SERVLET"><!-- --></A>
  1874. <div class="oddrow">
  1875. <div class="const-header">
  1876. <img src="../../media/images/Variable.png" />
  1877. <span class="const-title">
  1878. <span class="const-name">PING_SERVLET</span>
  1879. = <span class="const-default"> 'admin/ping'</span>
  1880. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a118">118</a></span>)
  1881. </span>
  1882. </div>
  1883. <!-- ========== Info from phpDoc block ========= -->
  1884. <p class="short-description">Servlet mappings</p>
  1885. </div>
  1886. <a name="constSEARCH_SERVLET" id="SEARCH_SERVLET"><!-- --></A>
  1887. <div class="evenrow">
  1888. <div class="const-header">
  1889. <img src="../../media/images/Variable.png" />
  1890. <span class="const-title">
  1891. <span class="const-name">SEARCH_SERVLET</span>
  1892. = <span class="const-default"> 'select'</span>
  1893. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a120">120</a></span>)
  1894. </span>
  1895. </div>
  1896. <!-- ========== Info from phpDoc block ========= -->
  1897. </div>
  1898. <a name="constSOLR_WRITER" id="SOLR_WRITER"><!-- --></A>
  1899. <div class="oddrow">
  1900. <div class="const-header">
  1901. <img src="../../media/images/Variable.png" />
  1902. <span class="const-title">
  1903. <span class="const-name">SOLR_WRITER</span>
  1904. = <span class="const-default"> 'json'</span>
  1905. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a101">101</a></span>)
  1906. </span>
  1907. </div>
  1908. <!-- ========== Info from phpDoc block ========= -->
  1909. <p class="short-description">Response writer we'll request - JSON. See http://code.google.com/p/solr-php-client/issues/detail?id=6#c1 for reasoning</p>
  1910. </div>
  1911. <a name="constSVN_ID" id="SVN_ID"><!-- --></A>
  1912. <div class="evenrow">
  1913. <div class="const-header">
  1914. <img src="../../media/images/Variable.png" />
  1915. <span class="const-title">
  1916. <span class="const-name">SVN_ID</span>
  1917. = <span class="const-default"> '$Id: Service.php 59 2011-02-08 20:38:59Z donovan.jimenez $'</span>
  1918. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a96">96</a></span>)
  1919. </span>
  1920. </div>
  1921. <!-- ========== Info from phpDoc block ========= -->
  1922. <p class="short-description">SVN ID meta data for this class</p>
  1923. </div>
  1924. <a name="constSVN_REVISION" id="SVN_REVISION"><!-- --></A>
  1925. <div class="oddrow">
  1926. <div class="const-header">
  1927. <img src="../../media/images/Variable.png" />
  1928. <span class="const-title">
  1929. <span class="const-name">SVN_REVISION</span>
  1930. = <span class="const-default"> '$Revision: 59 $'</span>
  1931. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a91">91</a></span>)
  1932. </span>
  1933. </div>
  1934. <!-- ========== Info from phpDoc block ========= -->
  1935. <p class="short-description">SVN Revision meta data for this class</p>
  1936. </div>
  1937. <a name="constTHREADS_SERVLET" id="THREADS_SERVLET"><!-- --></A>
  1938. <div class="evenrow">
  1939. <div class="const-header">
  1940. <img src="../../media/images/Variable.png" />
  1941. <span class="const-title">
  1942. <span class="const-name">THREADS_SERVLET</span>
  1943. = <span class="const-default"> 'admin/threads'</span>
  1944. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a121">121</a></span>)
  1945. </span>
  1946. </div>
  1947. <!-- ========== Info from phpDoc block ========= -->
  1948. </div>
  1949. <a name="constUPDATE_SERVLET" id="UPDATE_SERVLET"><!-- --></A>
  1950. <div class="oddrow">
  1951. <div class="const-header">
  1952. <img src="../../media/images/Variable.png" />
  1953. <span class="const-title">
  1954. <span class="const-name">UPDATE_SERVLET</span>
  1955. = <span class="const-default"> 'update'</span>
  1956. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a119">119</a></span>)
  1957. </span>
  1958. </div>
  1959. <!-- ========== Info from phpDoc block ========= -->
  1960. </div>
  1961. </div>
  1962. </div>
  1963. <p class="notes" id="credit">
  1964. Documentation generated on Wed, 04 May 2011 11:01:19 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  1965. </p>
  1966. </div></body>
  1967. </html>