123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621 |
- <?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_Response</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_Response</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">Represents a Solr response. Parses the raw response into a set of stdClass objects and associative arrays for easy access.</p>
- <p class="description"><p>Currently requires json_decode which is bundled with PHP >= 5.2.0, Alternatively can be installed with PECL. Zend Framework also includes a purely PHP solution.</p></p>
- <p class="notes">
- Located in <a class="field" href="_Response.php.html">/Response.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a48">48</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="#SVN_ID" title="details" class="const-name">SVN_ID</a> = <span class="var-type"> '$Id: Response.php 54 2011-02-04 16:29:18Z 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: 54 $'</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">mixed</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">boolean</span>
- <a href="#$_isParsed" title="details" class="var-name">$_isParsed</a>
- </div>
- <div class="var-title">
- <span class="var-type">mixed</span>
- <a href="#$_parsedData" title="details" class="var-name">$_parsedData</a>
- </div>
- <div class="var-title">
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
- <a href="#$_response" title="details" class="var-name">$_response</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">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
- <a href="#__construct" title="details" class="method-name">__construct</a>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span> <span class="var-name">$response</span>, [<span class="var-type">boolean</span> <span class="var-name">$createDocuments</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$collapseSingleValueArrays</span> = <span class="var-default">true</span>])
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getEncoding" title="details" class="method-name">getEncoding</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">integer</span>
- <a href="#getHttpStatus" title="details" class="method-name">getHttpStatus</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getHttpStatusMessage" title="details" class="method-name">getHttpStatusMessage</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getRawResponse" title="details" class="method-name">getRawResponse</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">string</span>
- <a href="#getType" title="details" class="method-name">getType</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">void</span>
- <a href="#_parseData" title="details" class="method-name">_parseData</a>
- ()
- </div>
-
- <div class="method-definition">
- <span class="method-result">mixed</span>
- <a href="#__get" title="details" class="method-name">__get</a>
- (<span class="var-type">string</span> <span class="var-name">$key</span>)
- </div>
-
- <div class="method-definition">
- <span class="method-result">boolean</span>
- <a href="#__isset" title="details" class="method-name">__isset</a>
- (<span class="var-type">string</span> <span class="var-name">$key</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">mixed</span>
- <span class="var-name">$_collapseSingleValueArrays</span>
- = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a88">88</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <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_Response.php.html#a87">87</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Data parsing flags. Determines what extra processing should be done after the data is initially converted to a data structure.</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_isParsed" id="$_isParsed"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">boolean</span>
- <span class="var-name">$_isParsed</span>
- = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a72">72</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Whether the raw response has been parsed</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_parsedData" id="$_parsedData"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$_parsedData</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a79">79</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Parsed representation of the data</p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$_response" id="$_response"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <span class="var-title">
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
- <span class="var-name">$_response</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a65">65</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Holds the raw response used in construction</p>
- <ul class="tags">
- <li><span class="field">var:</span> HTTP response</li>
- <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="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_Response.php.html#a97">97</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constructor. Takes the raw HTTP response body and the exploded HTTP headers</p>
- <ul class="tags">
- <li><span class="field">return:</span> HTTP response</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
- <span class="method-name">
- __construct
- </span>
- (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span> <span class="var-name">$response</span>, [<span class="var-type">boolean</span> <span class="var-name">$createDocuments</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span> <span class="var-name">$collapseSingleValueArrays</span> = <span class="var-default">true</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$createDocuments</span><span class="var-description">: Whether to convert the documents json_decoded as stdClass instances to Apache_Solr_Document instances</span> </li>
- <li>
- <span class="var-type">boolean</span>
- <span class="var-name">$collapseSingleValueArrays</span><span class="var-description">: Whether to make multivalued fields appear as single values</span> </li>
- <li>
- <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
- <span class="var-name">$response</span> </li>
- </ul>
-
-
- </div>
- <a name="methodgetEncoding" id="getEncoding"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getEncoding</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a139">139</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get character encoding of this response. Should usually be utf-8, but just in case</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">
- getEncoding
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetHttpStatus" id="getHttpStatus"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getHttpStatus</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a109">109</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the HTTP status code</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">
- getHttpStatus
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetHttpStatusMessage" id="getHttpStatusMessage"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getHttpStatusMessage</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a119">119</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the HTTP status message of the response</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">
- getHttpStatusMessage
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetRawResponse" id="getRawResponse"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">getRawResponse</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a149">149</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get the raw response as it was given to this object</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">
- getRawResponse
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetType" id="getType"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">getType</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a129">129</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Get content type of this Solr response</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">
- getType
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="method_parseData" id="_parseData"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">_parseData</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a198">198</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Parse the raw response into the parsed_data array for access</p>
- <ul class="tags">
- <li><span class="field">throws:</span> Apache_Solr_ParserException If the data could not be parsed</li>
- <li><span class="field">access:</span> protected</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- _parseData
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="method__get" id="__get"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <span class="method-title">__get</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a160">160</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Magic get to expose the parsed data and to lazily load it</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">mixed</span>
- <span class="method-name">
- __get
- </span>
- (<span class="var-type">string</span> <span class="var-name">$key</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$key</span> </li>
- </ul>
-
-
- </div>
- <a name="method__isset" id="__isset"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <span class="method-title">__isset</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a182">182</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Magic function for isset function on parsed data</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">
- __isset
- </span>
- (<span class="var-type">string</span> <span class="var-name">$key</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$key</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="constSVN_ID" id="SVN_ID"><!-- --></A>
- <div class="oddrow">
- <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: Response.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a58">58</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="evenrow">
- <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: 54 $'</span>
- (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_Response.php.html#a53">53</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">SVN Revision meta data for this class</p>
-
-
- </div>
-
- </div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Wed, 04 May 2011 11:01:15 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
- </p>
- </div></body>
- </html>
|