1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>Docs For Class Apache_Solr_Service</title>
- <link rel="stylesheet" href="../../media/stylesheet.css" />
- <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
- </head>
- <body>
- <div class="page-body">
- <h2 class="class-name">Class Apache_Solr_Service</h2>
- <a name="sec-description"></a>
- <div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <p class="description"><p>Example Usage: <div class="src-code"><ol><li><div class="src-line"> ...</div></li>
- <li><div class="src-line"> <span class="src-var">$solr </span>= <span class="src-key">new </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">; </span><span class="src-comm">//or explicitly new Apache_Solr_Service('localhost', 8180, '/solr')</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$solr</span><span class="src-sym">-></span><a href="../../Apache/Solr/Apache_Solr_Service.html#methodping">ping</a><span class="src-sym">(</span><span class="src-sym">))</span></div></li>
- <li><div class="src-line"> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"> <span class="src-var">$solr</span><span class="src-sym">-></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">; </span><span class="src-comm">//deletes ALL documents - be careful :)</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-var">$document </span>= <span class="src-key">new </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>
- <li><div class="src-line"> <span class="src-var">$document</span><span class="src-sym">-></span><span class="src-id">id </span>= <a href="http://www.php.net/uniqid">uniqid</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">//or something else suitably unique</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-var">$document</span><span class="src-sym">-></span><span class="src-id">title </span>= <span class="src-str">'Some Title'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"> <span class="src-var">$document</span><span class="src-sym">-></span><span class="src-id">content </span>= <span class="src-str">'Some content for this wonderful document. Blah blah blah.'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-var">$solr</span><span class="src-sym">-></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">; </span><span class="src-comm">//if you're going to be adding documents in bulk using addDocuments</span></div></li>
- <li><div class="src-line"> <span class="src-comm">//with an array of documents is faster</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-var">$solr</span><span class="src-sym">-></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">; </span><span class="src-comm">//commit to see the deletes and the document</span></div></li>
- <li><div class="src-line"> <span class="src-var">$solr</span><span class="src-sym">-></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">; </span><span class="src-comm">//merges multiple segments into one</span></div></li>
- <li><div class="src-line"> </div></li>
- <li><div class="src-line"> <span class="src-comm">//and the one we all care about, search!</span></div></li>
- <li><div class="src-line"> <span class="src-comm">//any other common or custom parameters to the request handler can go in the</span></div></li>
- <li><div class="src-line"> <span class="src-comm">//optional 4th array argument.</span></div></li>
- <li><div class="src-line"> <span class="src-var">$solr</span><span class="src-sym">-></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">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-num">10</span><span class="src-sym">, </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'sort' </span>=> <span class="src-str">'timestamp desc'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"> ...</div></li>
- </ol></div></p></p>
- <ul class="tags">
- <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>
- </ul>
- <p class="notes">
- 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>)
- </p>
-
-
- <pre></pre>
-
- </div>
- </div>
- <a name="sec-const-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Class Constant Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
-
- |
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="const-summary">
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#EXTRACT_SERVLET" title="details" class="const-name">EXTRACT_SERVLET</a> = <span class="var-type"> 'update/extract'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#METHOD_GET" title="details" class="const-name">METHOD_GET</a> = <span class="var-type"> 'GET'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#METHOD_POST" title="details" class="const-name">METHOD_POST</a> = <span class="var-type"> 'POST'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#NAMED_LIST_FLAT" title="details" class="const-name">NAMED_LIST_FLAT</a> = <span class="var-type"> 'flat'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#NAMED_LIST_MAP" title="details" class="const-name">NAMED_LIST_MAP</a> = <span class="var-type"> 'map'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#PING_SERVLET" title="details" class="const-name">PING_SERVLET</a> = <span class="var-type"> 'admin/ping'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#SEARCH_SERVLET" title="details" class="const-name">SEARCH_SERVLET</a> = <span class="var-type"> 'select'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#SOLR_WRITER" title="details" class="const-name">SOLR_WRITER</a> = <span class="var-type"> 'json'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <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>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#SVN_REVISION" title="details" class="const-name">SVN_REVISION</a> = <span class="var-type"> '$Revision: 59 $'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#THREADS_SERVLET" title="details" class="const-name">THREADS_SERVLET</a> = <span class="var-type"> 'admin/threads'</span>
- </div>
- <div class="const-title">
- <img src="../../media/images/Constant.png" alt=" " />
- <a href="#UPDATE_SERVLET" title="details" class="const-name">UPDATE_SERVLET</a> = <span class="var-type"> 'update'</span>
- </div>
- </div>
- </div>
- </div>
- <a name="sec-var-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Variable Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="var-summary">
- <div class="var-title">
- <span class="var-type">boolean</span>
- <a href="#$_collapseSingleValueArrays" title="details" class="var-name">$_collapseSingleValueArrays</a>
- </div>
- <div class="var-title">
- <span class="var-type">boolean</span>
- <a href="#$_createDocuments" title="details" class="var-name">$_createDocuments</a>
- </div>
- <div class="var-title">
- <span class="var-type">string</span>
- <a href="#$_host" title="details" class="var-name">$_host</a>
- </div>
- <div class="var-title">
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
- <a href="#$_httpTransport" title="details" class="var-name">$_httpTransport</a>
- </div>
- <div class="var-title">
- <span class="var-type">string</span>
- <a href="#$_namedListTreatment" title="details" class="var-name">$_namedListTreatment</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_path" title="details" class="var-name">$_path</a>
- </div>
- <div class="var-title">
- <span class="var-type">string</span>
- <a href="#$_pingUrl" title="details" class="var-name">$_pingUrl</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_port" title="details" class="var-name">$_port</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_queryBracketsEscaped" title="details" class="var-name">$_queryBracketsEscaped</a>
- </div>
- <div class="var-title">
- <span class="var-type">string</span>
- <a href="#$_queryDelimiter" title="details" class="var-name">$_queryDelimiter</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_queryStringDelimiter" title="details" class="var-name">$_queryStringDelimiter</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_searchUrl" title="details" class="var-name">$_searchUrl</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_threadsUrl" title="details" class="var-name">$_threadsUrl</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_updateUrl" title="details" class="var-name">$_updateUrl</a>
- </div>
- <div class="var-title">
- <span class="var-type">boolean</span>
- <a href="#$_urlsInited" title="details" class="var-name">$_urlsInited</a>
- </div>
- </div>
- </div>
- </div>
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
-
- |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
-
- <div class="method-definition">
- static <span class="method-result">string</span>
- <a href="#escape" title="details" class="method-name">escape</a>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <div class="method-definition">
- static <span class="method-result">string</span>
- <a href="#escapePhrase" title="details" class="method-name">escapePhrase</a>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <div class="method-definition">
- static <span class="method-result">string</span>
- <a href="#phrase" title="details" class="method-name">phrase</a>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#add" title="details" class="method-name">add</a>
- (<span class="var-type">string</span> <span class="var-name">$rawPost</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#addDocument" title="details" class="method-name">addDocument</a>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span> <span class="var-name">$document</span>, [<span class="var-type">boolean</span> <span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span> <span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#addDocuments" title="details" class="method-name">addDocuments</a>
- (<span class="var-type">array</span> <span class="var-name">$documents</span>, [<span class="var-type">boolean</span> <span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span> <span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#commit" title="details" class="method-name">commit</a>
- ([<span class="var-type">boolean</span> <span class="var-name">$expungeDeletes</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#delete" title="details" class="method-name">delete</a>
- (<span class="var-type">string</span> <span class="var-name">$rawPost</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#deleteById" title="details" class="method-name">deleteById</a>
- (<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#deleteByMultipleIds" title="details" class="method-name">deleteByMultipleIds</a>
- (<span class="var-type">array</span> <span class="var-name">$ids</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#deleteByQuery" title="details" class="method-name">deleteByQuery</a>
- (<span class="var-type">string</span> <span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#extract" title="details" class="method-name">extract</a>
- (<span class="var-type">string</span> <span class="var-name">$file</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#extractFromString" title="details" class="method-name">extractFromString</a>
- (<span class="var-type">string</span> <span class="var-name">$data</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#extractFromUrl" title="details" class="method-name">extractFromUrl</a>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">boolean</span>
- <a href="#getCollapseSingleValueArrays" title="details" class="method-name">getCollapseSingleValueArrays</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">boolean</span>
- <a href="#getCreateDocuments" title="details" class="method-name">getCreateDocuments</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">float</span>
- <a href="#getDefaultTimeout" title="details" class="method-name">getDefaultTimeout</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getHost" title="details" class="method-name">getHost</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">HttpTransportInterface</span>
- <a href="#getHttpTransport" title="details" class="method-name">getHttpTransport</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getNamedListTreatment" title="details" class="method-name">getNamedListTreatment</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getPath" title="details" class="method-name">getPath</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">integer</span>
- <a href="#getPort" title="details" class="method-name">getPort</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">Apache_Solr_Service</span>
- <a href="#__construct" title="details" class="method-name">__construct</a>
- ([<span class="var-type">string</span> <span class="var-name">$host</span> = <span class="var-default">'localhost'</span>], [<span class="var-type">string</span> <span class="var-name">$port</span> = <span class="var-default">8180</span>], [<span class="var-type">string</span> <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> <span class="var-name">$httpTransport</span> = <span class="var-default">false</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#optimize" title="details" class="method-name">optimize</a>
- ([<span class="var-type">boolean</span> <span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">float</span>
- <a href="#ping" title="details" class="method-name">ping</a>
- ([<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">2</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#search" title="details" class="method-name">search</a>
- (<span class="var-type">string</span> <span class="var-name">$query</span>, [<span class="var-type">int</span> <span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span> <span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span> <span class="var-name">$method</span> = <span class="var-default">self::METHOD_GET</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setCollapseSingleValueArrays" title="details" class="method-name">setCollapseSingleValueArrays</a>
- (<span class="var-type">boolean</span> <span class="var-name">$collapseSingleValueArrays</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setCreateDocuments" title="details" class="method-name">setCreateDocuments</a>
- (<span class="var-type">boolean</span> <span class="var-name">$createDocuments</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setDefaultTimeout" title="details" class="method-name">setDefaultTimeout</a>
- (<span class="var-type">float</span> <span class="var-name">$timeout</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setHost" title="details" class="method-name">setHost</a>
- (<span class="var-type">string</span> <span class="var-name">$host</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setHttpTransport" title="details" class="method-name">setHttpTransport</a>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span> <span class="var-name">$httpTransport</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setNamedListTreatment" title="details" class="method-name">setNamedListTreatment</a>
- (<span class="var-type">string</span> <span class="var-name">$namedListTreatment</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setPath" title="details" class="method-name">setPath</a>
- (<span class="var-type">string</span> <span class="var-name">$path</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setPort" title="details" class="method-name">setPort</a>
- (<span class="var-type">integer</span> <span class="var-name">$port</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setQueryDelimiter" title="details" class="method-name">setQueryDelimiter</a>
- (<span class="var-type">string</span> <span class="var-name">$queryDelimiter</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#setQueryStringDelimiter" title="details" class="method-name">setQueryStringDelimiter</a>
- (<span class="var-type">string</span> <span class="var-name">$queryStringDelimiter</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#threads" title="details" class="method-name">threads</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#_constructUrl" title="details" class="method-name">_constructUrl</a>
- (<span class="var-type">string</span> <span class="var-name">$servlet</span>, [<span class="var-type"></span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#_documentToXmlFragment" title="details" class="method-name">_documentToXmlFragment</a>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span> <span class="var-name">$document</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#_generateQueryString" title="details" class="method-name">_generateQueryString</a>
- (<span class="var-type"></span> <span class="var-name">$params</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#_initUrls" title="details" class="method-name">_initUrls</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#_sendRawGet" title="details" class="method-name">_sendRawGet</a>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <a href="#_sendRawPost" title="details" class="method-name">_sendRawPost</a>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$rawPost</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$contentType</span> = <span class="var-default">'text/xml; charset=UTF-8'</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#_stripCtrlChars" title="details" class="method-name">_stripCtrlChars</a>
- (<span class="var-type">string</span> <span class="var-name">$string</span>)
- </div>
- </div>
- </div>
- </div>
- <a name="sec-vars"></a>
- <div class="info-box">
- <div class="info-box-title">Variables</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
-
-
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
-
- <a name="var$_collapseSingleValueArrays" id="$_collapseSingleValueArrays"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">boolean</span>
- <span class="var-name">$_collapseSingleValueArrays</span>
- = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a145">145</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_createDocuments" id="$_createDocuments"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">boolean</span>
- <span class="var-name">$_createDocuments</span>
- = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a137">137</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_host" id="$_host"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$_host</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Server identification strings</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_httpTransport" id="$_httpTransport"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
- <span class="var-name">$_httpTransport</span>
- = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a182">182</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">HTTP Transport implementation (pluggable)</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_namedListTreatment" id="$_namedListTreatment"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$_namedListTreatment</span>
- = <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>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_path" id="$_path"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_path</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_pingUrl" id="$_pingUrl"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$_pingUrl</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constructed servlet full path URLs</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_port" id="$_port"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_port</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a129">129</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_queryBracketsEscaped" id="$_queryBracketsEscaped"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_queryBracketsEscaped</span>
- = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_queryDelimiter" id="$_queryDelimiter"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">string</span>
- <span class="var-name">$_queryDelimiter</span>
- = <span class="var-default"> '?'</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Query delimiters. Someone might want to be able to change these (to use &amp; instead of & for example), so I've provided them.</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_queryStringDelimiter" id="$_queryStringDelimiter"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_queryStringDelimiter</span>
- = <span class="var-default"> '&'</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a161">161</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_searchUrl" id="$_searchUrl"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_searchUrl</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_threadsUrl" id="$_threadsUrl"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_threadsUrl</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_updateUrl" id="$_updateUrl"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_updateUrl</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a168">168</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_urlsInited" id="$_urlsInited"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">boolean</span>
- <span class="var-name">$_urlsInited</span>
- = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a175">175</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Keep track of whether our URLs have been constructed</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
-
- </div>
- </div>
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
-
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
- <a name="methodescape" id="escape"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <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>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.</p>
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- static <span class="method-result">string</span>
- <span class="method-name">
- escape
- </span>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$value</span> </li>
- </ul>
-
-
- </div>
- <a name="methodescapePhrase" id="escapePhrase"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <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>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Escape a value meant to be contained in a phrase for special query characters</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- static <span class="method-result">string</span>
- <span class="method-name">
- escapePhrase
- </span>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$value</span> </li>
- </ul>
-
-
- </div>
- <a name="methodphrase" id="phrase"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <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>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Convenience function for creating phrase syntax from a value</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- static <span class="method-result">string</span>
- <span class="method-name">
- phrase
- </span>
- (<span class="var-type">string</span> <span class="var-name">$value</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$value</span> </li>
- </ul>
-
-
- </div>
- <a name="methodadd" id="add"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">add</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a667">667</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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 "add" xml document.</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- add
- </span>
- (<span class="var-type">string</span> <span class="var-name">$rawPost</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$rawPost</span> </li>
- </ul>
-
-
- </div>
- <a name="methodaddDocument" id="addDocument"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">addDocument</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a684">684</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Add a Solr Document to the index</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- addDocument
- </span>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span> <span class="var-name">$document</span>, [<span class="var-type">boolean</span> <span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span> <span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
- <span class="var-name">$document</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$allowDups</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$overwritePending</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$overwriteCommitted</span> </li>
- <li>
- <span class="var-type">integer</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodaddDocuments" id="addDocuments"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">addDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a712">712</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Add an array of Solr Documents to the index all at once</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- addDocuments
- </span>
- (<span class="var-type">array</span> <span class="var-name">$documents</span>, [<span class="var-type">boolean</span> <span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span> <span class="var-name">$commitWithin</span> = <span class="var-default">0</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array</span>
- <span class="var-name">$documents</span><span class="var-description">: Should be an array of Apache_Solr_Document instances</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$allowDups</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$overwritePending</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$overwriteCommitted</span> </li>
- <li>
- <span class="var-type">integer</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodcommit" id="commit"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">commit</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a821">821</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Send a commit command. Will be synchronous unless both wait parameters are set to false.</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- commit
- </span>
- ([<span class="var-type">boolean</span> <span class="var-name">$expungeDeletes</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$expungeDeletes</span><span class="var-description">: Defaults to false, merge segments with deletes away</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$waitFlush</span><span class="var-description">: Defaults to true, block until index changes are flushed to disk</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <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>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methoddelete" id="delete"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">delete</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a842">842</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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 "delete" xml document</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- delete
- </span>
- (<span class="var-type">string</span> <span class="var-name">$rawPost</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$rawPost</span><span class="var-description">: Expected to be utf-8 encoded xml document</span> </li>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methoddeleteById" id="deleteById"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">deleteById</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a858">858</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Create a delete document based on document ID</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- deleteById
- </span>
- (<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$id</span><span class="var-description">: Expected to be utf-8 encoded</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromPending</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromCommitted</span> </li>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methoddeleteByMultipleIds" id="deleteByMultipleIds"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">deleteByMultipleIds</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a882">882</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Create and post a delete document based on multiple document IDs.</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- deleteByMultipleIds
- </span>
- (<span class="var-type">array</span> <span class="var-name">$ids</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array</span>
- <span class="var-name">$ids</span><span class="var-description">: Expected to be utf-8 encoded strings</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromPending</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromCommitted</span> </li>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methoddeleteByQuery" id="deleteByQuery"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">deleteByQuery</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a913">913</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Create a delete document based on a query and submit it</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- deleteByQuery
- </span>
- (<span class="var-type">string</span> <span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span> <span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$rawQuery</span><span class="var-description">: Expected to be utf-8 encoded</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromPending</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$fromCommitted</span> </li>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodextract" id="extract"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">extract</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a944">944</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by "literal." and "boost." 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 "literal.id" key and value in your $params array but you also pass in a document isntance with an "id" field" - the document's value(s) will take precedence).</p></p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- extract
- </span>
- (<span class="var-type">string</span> <span class="var-name">$file</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$file</span><span class="var-description">: Path to file to extract data from</span> </li>
- <li>
- <span class="var-type">array</span>
- <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>
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
- <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>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
- </ul>
-
-
- </div>
- <a name="methodextractFromString" id="extractFromString"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">extractFromString</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1005">1005</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by "literal." and "boost." 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 "literal.id" key and value in your $params array but you also pass in a document isntance with an "id" field" - the document's value(s) will take precedence).</p></p>
- <ul class="tags">
- <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>
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- extractFromString
- </span>
- (<span class="var-type">string</span> <span class="var-name">$data</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$data</span><span class="var-description">: Data that will be passed to Solr Cell</span> </li>
- <li>
- <span class="var-type">array</span>
- <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>
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
- <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>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
- </ul>
-
-
- </div>
- <a name="methodextractFromUrl" id="extractFromUrl"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">extractFromUrl</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1068">1068</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by "literal." and "boost." 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 "literal.id" key and value in your $params array but you also pass in a document isntance with an "id" field" - the document's value(s) will take precedence).</p></p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $url, $params, or $document are invalid.</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- extractFromUrl
- </span>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">array</span> <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> <span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$url</span><span class="var-description">: URL</span> </li>
- <li>
- <span class="var-type">array</span>
- <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>
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
- <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>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
- </ul>
-
-
- </div>
- <a name="methodgetCollapseSingleValueArrays" id="getCollapseSingleValueArrays"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getCollapseSingleValueArrays</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a533">533</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the current state of the collapse single value arrays flag.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">boolean</span>
- <span class="method-name">
- getCollapseSingleValueArrays
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetCreateDocuments" id="getCreateDocuments"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a513">513</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the current state of teh create documents flag.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">boolean</span>
- <span class="method-name">
- getCreateDocuments
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetDefaultTimeout" id="getDefaultTimeout"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a546">546</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the current default timeout setting (initially the default_socket_timeout ini setting) in seconds</p>
- <ul class="tags">
- <li><span class="field">deprecated:</span> Use the getDefaultTimeout method on the HTTP transport implementation</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">float</span>
- <span class="method-name">
- getDefaultTimeout
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetHost" id="getHost"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getHost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a375">375</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Returns the set host</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getHost
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetHttpTransport" id="getHttpTransport"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getHttpTransport</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a474">474</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the current configured HTTP Transport</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">HttpTransportInterface</span>
- <span class="method-name">
- getHttpTransport
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetNamedListTreatment" id="getNamedListTreatment"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getNamedListTreatment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a592">592</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the current setting for named list treatment.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getNamedListTreatment
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetPath" id="getPath"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getPath</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a447">447</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the set path.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getPath
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetPort" id="getPort"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getPort</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a410">410</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the set port</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">integer</span>
- <span class="method-name">
- getPort
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="method__construct" id="__construct"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <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>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constructor. All parameters are optional and will take on default values if not specified.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">Apache_Solr_Service</span>
- <span class="method-name">
- __construct
- </span>
- ([<span class="var-type">string</span> <span class="var-name">$host</span> = <span class="var-default">'localhost'</span>], [<span class="var-type">string</span> <span class="var-name">$port</span> = <span class="var-default">8180</span>], [<span class="var-type">string</span> <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> <span class="var-name">$httpTransport</span> = <span class="var-default">false</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$host</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$port</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$path</span> </li>
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
- <span class="var-name">$httpTransport</span> </li>
- </ul>
-
-
- </div>
- <a name="methodoptimize" id="optimize"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">optimize</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1117">1117</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Send an optimize command. Will be synchronous unless both wait parameters are set to false.</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- optimize
- </span>
- ([<span class="var-type">boolean</span> <span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$waitFlush</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$waitSearcher</span> </li>
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodping" id="ping"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">ping</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a626">626</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">return:</span> Actual time taken to ping the server, FALSE if timeout or HTTP error status occurs</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">float</span>
- <span class="method-name">
- ping
- </span>
- ([<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">2</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">float</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodsearch" id="search"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">search</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a1140">1140</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Simple Search interface</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If an invalid HTTP method is used</li>
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- search
- </span>
- (<span class="var-type">string</span> <span class="var-name">$query</span>, [<span class="var-type">int</span> <span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span> <span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span> <span class="var-name">$method</span> = <span class="var-default">self::METHOD_GET</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$query</span><span class="var-description">: The raw query string</span> </li>
- <li>
- <span class="var-type">int</span>
- <span class="var-name">$offset</span><span class="var-description">: The starting offset for result documents</span> </li>
- <li>
- <span class="var-type">int</span>
- <span class="var-name">$limit</span><span class="var-description">: The maximum number of result documents to return</span> </li>
- <li>
- <span class="var-type">array</span>
- <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>
- <li>
- <span class="var-type">string</span>
- <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>
- </ul>
-
-
- </div>
- <a name="methodsetCollapseSingleValueArrays" id="setCollapseSingleValueArrays"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">setCollapseSingleValueArrays</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a523">523</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the collapse single value arrays flag.</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setCollapseSingleValueArrays
- </span>
- (<span class="var-type">boolean</span> <span class="var-name">$collapseSingleValueArrays</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$collapseSingleValueArrays</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetCreateDocuments" id="setCreateDocuments"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a503">503</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setCreateDocuments
- </span>
- (<span class="var-type">boolean</span> <span class="var-name">$createDocuments</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$createDocuments</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetDefaultTimeout" id="setDefaultTimeout"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">setDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a558">558</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the default timeout for all calls that aren't passed a specific timeout</p>
- <ul class="tags">
- <li><span class="field">deprecated:</span> Use the setDefaultTimeout method on the HTTP transport implementation</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setDefaultTimeout
- </span>
- (<span class="var-type">float</span> <span class="var-name">$timeout</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$timeout</span><span class="var-description">: Timeout value in seconds</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetHost" id="setHost"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setHost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a387">387</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the host used. If empty will fallback to constants</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If the host parameter is empty</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setHost
- </span>
- (<span class="var-type">string</span> <span class="var-name">$host</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$host</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetHttpTransport" id="setHttpTransport"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">setHttpTransport</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a492">492</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the HTTP Transport implemenation that will be used for all HTTP requests</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setHttpTransport
- </span>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span> <span class="var-name">$httpTransport</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></span>
- <span class="var-name">$httpTransport</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetNamedListTreatment" id="setNamedListTreatment"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setNamedListTreatment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a570">570</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If invalid option is set</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setNamedListTreatment
- </span>
- (<span class="var-type">string</span> <span class="var-name">$namedListTreatment</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$namedListTreatment</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetPath" id="setPath"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">setPath</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a457">457</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the path used. If empty will fallback to constants</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setPath
- </span>
- (<span class="var-type">string</span> <span class="var-name">$path</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$path</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetPort" id="setPort"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setPort</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a422">422</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the port used. If empty will fallback to constants</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If the port parameter is empty</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setPort
- </span>
- (<span class="var-type">integer</span> <span class="var-name">$port</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">integer</span>
- <span class="var-name">$port</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetQueryDelimiter" id="setQueryDelimiter"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">setQueryDelimiter</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a603">603</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the string used to separate the path form the query string.</p>
- <p class="description"><p>Defaulted to '?'</p></p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setQueryDelimiter
- </span>
- (<span class="var-type">string</span> <span class="var-name">$queryDelimiter</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$queryDelimiter</span> </li>
- </ul>
-
-
- </div>
- <a name="methodsetQueryStringDelimiter" id="setQueryStringDelimiter"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">setQueryStringDelimiter</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a614">614</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Set the string used to separate the parameters in thequery string Defaulted to '&'</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setQueryStringDelimiter
- </span>
- (<span class="var-type">string</span> <span class="var-name">$queryStringDelimiter</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$queryStringDelimiter</span> </li>
- </ul>
-
-
- </div>
- <a name="methodthreads" id="threads"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">threads</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a653">653</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- threads
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="method_constructUrl" id="_constructUrl"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">_constructUrl</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a258">258</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Return a valid http URL given this server's host, port and path and a provided servlet name</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- _constructUrl
- </span>
- (<span class="var-type">string</span> <span class="var-name">$servlet</span>, [<span class="var-type"></span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$servlet</span> </li>
- <li>
- <span class="var-type"></span>
- <span class="var-name">$params</span> </li>
- </ul>
-
-
- </div>
- <a name="method_documentToXmlFragment" id="_documentToXmlFragment"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">_documentToXmlFragment</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a741">741</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <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>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- _documentToXmlFragment
- </span>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span> <span class="var-name">$document</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
- <span class="var-name">$document</span> </li>
- </ul>
-
-
- </div>
- <a name="method_generateQueryString" id="_generateQueryString"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">_generateQueryString</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a295">295</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- _generateQueryString
- </span>
- (<span class="var-type"></span> <span class="var-name">$params</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$params</span> </li>
- </ul>
-
-
- </div>
- <a name="method_initUrls" id="_initUrls"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">_initUrls</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a283">283</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Construct the Full URLs for the three servlets we reference</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- _initUrls
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="method_sendRawGet" id="_sendRawGet"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">_sendRawGet</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a329">329</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Central method for making a get operation against this Solr Server</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If a non 200 response status is returned</li>
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- _sendRawGet
- </span>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$url</span> </li>
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$timeout</span><span class="var-description">: Read timeout in seconds</span> </li>
- </ul>
-
-
- </div>
- <a name="method_sendRawPost" id="_sendRawPost"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">_sendRawPost</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a355">355</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Central method for making a post operation against this Solr Server</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If a non 200 response status is returned</li>
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
- <span class="method-name">
- _sendRawPost
- </span>
- (<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$rawPost</span>, [<span class="var-type">float</span> <span class="var-name">$timeout</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$contentType</span> = <span class="var-default">'text/xml; charset=UTF-8'</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$url</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$rawPost</span> </li>
- <li>
- <span class="var-type">float</span>
- <span class="var-name">$timeout</span><span class="var-description">: Read timeout in seconds</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$contentType</span> </li>
- </ul>
-
-
- </div>
- <a name="method_stripCtrlChars" id="_stripCtrlChars"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">_stripCtrlChars</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a803">803</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Replace control (non-printable) characters from string that are invalid to Solr's XML parser with a space.</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- _stripCtrlChars
- </span>
- (<span class="var-type">string</span> <span class="var-name">$string</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$string</span> </li>
- </ul>
-
-
- </div>
-
- </div>
- </div>
- <a name="sec-consts"></a>
- <div class="info-box">
- <div class="info-box-title">Class Constants</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
-
-
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <a name="constEXTRACT_SERVLET" id="EXTRACT_SERVLET"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">EXTRACT_SERVLET</span>
- = <span class="const-default"> 'update/extract'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a122">122</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="constMETHOD_GET" id="METHOD_GET"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">METHOD_GET</span>
- = <span class="const-default"> 'GET'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a112">112</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Search HTTP Methods</p>
-
-
- </div>
- <a name="constMETHOD_POST" id="METHOD_POST"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">METHOD_POST</span>
- = <span class="const-default"> 'POST'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a113">113</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="constNAMED_LIST_FLAT" id="NAMED_LIST_FLAT"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">NAMED_LIST_FLAT</span>
- = <span class="const-default"> 'flat'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a106">106</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">NamedList Treatment constants</p>
-
-
- </div>
- <a name="constNAMED_LIST_MAP" id="NAMED_LIST_MAP"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">NAMED_LIST_MAP</span>
- = <span class="const-default"> 'map'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a107">107</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="constPING_SERVLET" id="PING_SERVLET"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">PING_SERVLET</span>
- = <span class="const-default"> 'admin/ping'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a118">118</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Servlet mappings</p>
-
-
- </div>
- <a name="constSEARCH_SERVLET" id="SEARCH_SERVLET"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">SEARCH_SERVLET</span>
- = <span class="const-default"> 'select'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a120">120</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="constSOLR_WRITER" id="SOLR_WRITER"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">SOLR_WRITER</span>
- = <span class="const-default"> 'json'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a101">101</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <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>
-
-
- </div>
- <a name="constSVN_ID" id="SVN_ID"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">SVN_ID</span>
- = <span class="const-default"> '$Id: Service.php 59 2011-02-08 20:38:59Z donovan.jimenez $'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a96">96</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">SVN ID meta data for this class</p>
-
-
- </div>
- <a name="constSVN_REVISION" id="SVN_REVISION"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">SVN_REVISION</span>
- = <span class="const-default"> '$Revision: 59 $'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a91">91</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">SVN Revision meta data for this class</p>
-
-
- </div>
- <a name="constTHREADS_SERVLET" id="THREADS_SERVLET"><!-- --></A>
- <div class="evenrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">THREADS_SERVLET</span>
- = <span class="const-default"> 'admin/threads'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a121">121</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
- <a name="constUPDATE_SERVLET" id="UPDATE_SERVLET"><!-- --></A>
- <div class="oddrow">
- <div class="const-header">
- <img src="../../media/images/Variable.png" />
- <span class="const-title">
- <span class="const-name">UPDATE_SERVLET</span>
- = <span class="const-default"> 'update'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Service.php.html#a119">119</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
- </div>
-
- </div>
- </div>
- <p class="notes" id="credit">
- 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>
- </p>
- </div></body>
- </html>
|