267 lines
50 KiB
HTML
267 lines
50 KiB
HTML
<?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>File Source for Response.php</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<h1>Source for file Response.php</h1>
|
|
<p>Documentation is available at <a href="../Apache/Solr/_Response.php.html">Response.php</a></p>
|
|
<div class="src-code">
|
|
<div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
|
|
<li><div class="src-line"><a name="a2"></a><span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a3"></a><span class="src-doc"> * Copyright (c) 2007-2011, Servigistics, Inc.</span></div></li>
|
|
<li><div class="src-line"><a name="a4"></a><span class="src-doc"> * All rights reserved.</span></div></li>
|
|
<li><div class="src-line"><a name="a5"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a6"></a><span class="src-doc"> * Redistribution and use in source and binary forms, with or without</span></div></li>
|
|
<li><div class="src-line"><a name="a7"></a><span class="src-doc"> * modification, are permitted provided that the following conditions are met:</span></div></li>
|
|
<li><div class="src-line"><a name="a8"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a9"></a><span class="src-doc"> * - Redistributions of source code must retain the above copyright notice,</span></div></li>
|
|
<li><div class="src-line"><a name="a10"></a><span class="src-doc"> * this list of conditions and the following disclaimer.</span></div></li>
|
|
<li><div class="src-line"><a name="a11"></a><span class="src-doc"> * - Redistributions in binary form must reproduce the above copyright</span></div></li>
|
|
<li><div class="src-line"><a name="a12"></a><span class="src-doc"> * notice, this list of conditions and the following disclaimer in the</span></div></li>
|
|
<li><div class="src-line"><a name="a13"></a><span class="src-doc"> * documentation and/or other materials provided with the distribution.</span></div></li>
|
|
<li><div class="src-line"><a name="a14"></a><span class="src-doc"> * - Neither the name of Servigistics, Inc. nor the names of</span></div></li>
|
|
<li><div class="src-line"><a name="a15"></a><span class="src-doc"> * its contributors may be used to endorse or promote products derived from</span></div></li>
|
|
<li><div class="src-line"><a name="a16"></a><span class="src-doc"> * this software without specific prior written permission.</span></div></li>
|
|
<li><div class="src-line"><a name="a17"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a18"></a><span class="src-doc"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div></li>
|
|
<li><div class="src-line"><a name="a19"></a><span class="src-doc"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div></li>
|
|
<li><div class="src-line"><a name="a20"></a><span class="src-doc"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div></li>
|
|
<li><div class="src-line"><a name="a21"></a><span class="src-doc"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div></li>
|
|
<li><div class="src-line"><a name="a22"></a><span class="src-doc"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div></li>
|
|
<li><div class="src-line"><a name="a23"></a><span class="src-doc"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div></li>
|
|
<li><div class="src-line"><a name="a24"></a><span class="src-doc"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div></li>
|
|
<li><div class="src-line"><a name="a25"></a><span class="src-doc"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div></li>
|
|
<li><div class="src-line"><a name="a26"></a><span class="src-doc"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div></li>
|
|
<li><div class="src-line"><a name="a27"></a><span class="src-doc"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div></li>
|
|
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * POSSIBILITY OF SUCH DAMAGE.</span></div></li>
|
|
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright 2007-2011 Servigistics, Inc. (http://servigistics.com)</span></div></li>
|
|
<li><div class="src-line"><a name="a31"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://solr-php-client.googlecode.com/svn/trunk/COPYING New BSD</span></div></li>
|
|
<li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Id: Response.php 54 2011-02-04 16:29:18Z donovan.jimenez $</span></div></li>
|
|
<li><div class="src-line"><a name="a33"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Apache</span></div></li>
|
|
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@subpackage</span><span class="src-doc"> Solr</span></div></li>
|
|
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Donovan Jimenez <djimenez@conduit-it.com></span></div></li>
|
|
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a38"></a> </div></li>
|
|
<li><div class="src-line"><a name="a39"></a><span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">) </span>. <span class="src-str">'/ParserException.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a40"></a> </div></li>
|
|
<li><div class="src-line"><a name="a41"></a><span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a42"></a><span class="src-doc"> * Represents a Solr response. Parses the raw response into a set of stdClass objects</span></div></li>
|
|
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> * and associative arrays for easy access.</span></div></li>
|
|
<li><div class="src-line"><a name="a44"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a45"></a><span class="src-doc"> * Currently requires json_decode which is bundled with PHP >= 5.2.0, Alternatively can be</span></div></li>
|
|
<li><div class="src-line"><a name="a46"></a><span class="src-doc"> * installed with PECL. Zend Framework also includes a purely PHP solution.</span></div></li>
|
|
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a48"></a><span class="src-key">class </span><a href="../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></div></li>
|
|
<li><div class="src-line"><a name="a49"></a><span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a50"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a51"></a><span class="src-doc"> * SVN Revision meta data for this class</span></div></li>
|
|
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a53"></a> <span class="src-key">const </span><span class="src-id">SVN_REVISION </span>= <span class="src-str">'$Revision: 54 $'</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a54"></a> </div></li>
|
|
<li><div class="src-line"><a name="a55"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * SVN ID meta data for this class</span></div></li>
|
|
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a58"></a> <span class="src-key">const </span><span class="src-id">SVN_ID </span>= <span class="src-str">'$Id: Response.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a59"></a> </div></li>
|
|
<li><div class="src-line"><a name="a60"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a61"></a><span class="src-doc"> * Holds the raw response used in construction</span></div></li>
|
|
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">Apache_Solr_HttpTransport_Response </span><span class="src-doc">HTTP response</span></div></li>
|
|
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a65"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">$_response</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a66"></a> </div></li>
|
|
<li><div class="src-line"><a name="a67"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a68"></a><span class="src-doc"> * Whether the raw response has been parsed</span></div></li>
|
|
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">boolean </span></div></li>
|
|
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a72"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_isParsed">$_isParsed</a> = <span class="src-id">false</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a73"></a> </div></li>
|
|
<li><div class="src-line"><a name="a74"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a75"></a><span class="src-doc"> * Parsed representation of the data</span></div></li>
|
|
<li><div class="src-line"><a name="a76"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a77"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">mixed </span></div></li>
|
|
<li><div class="src-line"><a name="a78"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a79"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_parsedData">$_parsedData</a><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a80"></a> </div></li>
|
|
<li><div class="src-line"><a name="a81"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a82"></a><span class="src-doc"> * Data parsing flags. Determines what extra processing should be done</span></div></li>
|
|
<li><div class="src-line"><a name="a83"></a><span class="src-doc"> * after the data is initially converted to a data structure.</span></div></li>
|
|
<li><div class="src-line"><a name="a84"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">boolean </span></div></li>
|
|
<li><div class="src-line"><a name="a86"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a87"></a> <span class="src-key">protected </span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_createDocuments">$_createDocuments</a> = <span class="src-id">true</span><span class="src-sym">,</span></div></li>
|
|
<li><div class="src-line"><a name="a88"></a> <a href="../Apache/Solr/Apache_Solr_Response.html#var$_collapseSingleValueArrays">$_collapseSingleValueArrays</a> = <span class="src-id">true</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a89"></a> </div></li>
|
|
<li><div class="src-line"><a name="a90"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a91"></a><span class="src-doc"> * Constructor. Takes the raw HTTP response body and the exploded HTTP headers</span></div></li>
|
|
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">Apache_Solr_HttpTransport_Response </span><span class="src-doc">HTTP response</span></div></li>
|
|
<li><div class="src-line"><a name="a94"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span><span class="src-doc-var">$createDocuments </span><span class="src-doc">Whether to convert the documents json_decoded as stdClass instances to Apache_Solr_Document instances</span></div></li>
|
|
<li><div class="src-line"><a name="a95"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span><span class="src-doc-var">$collapseSingleValueArrays </span><span class="src-doc">Whether to make multivalued fields appear as single values</span></div></li>
|
|
<li><div class="src-line"><a name="a96"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a97"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-id">Apache_Solr_HttpTransport_Response </span><span class="src-var">$response</span><span class="src-sym">, </span><span class="src-var">$createDocuments </span>= <span class="src-id">true</span><span class="src-sym">, </span><span class="src-var">$collapseSingleValueArrays </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a98"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a99"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a> = <span class="src-var">$response</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a100"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_createDocuments">_createDocuments</a> = (bool) <span class="src-var">$createDocuments</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a101"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_collapseSingleValueArrays">_collapseSingleValueArrays</a> = (bool) <span class="src-var">$collapseSingleValueArrays</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a102"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a103"></a> </div></li>
|
|
<li><div class="src-line"><a name="a104"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a105"></a><span class="src-doc"> * Get the HTTP status code</span></div></li>
|
|
<li><div class="src-line"><a name="a106"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a107"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">integer </span></div></li>
|
|
<li><div class="src-line"><a name="a108"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a109"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#methodgetHttpStatus">getHttpStatus</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a110"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a111"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetStatusCode">getStatusCode</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a112"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a113"></a> </div></li>
|
|
<li><div class="src-line"><a name="a114"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a115"></a><span class="src-doc"> * Get the HTTP status message of the response</span></div></li>
|
|
<li><div class="src-line"><a name="a116"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a117"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
|
|
<li><div class="src-line"><a name="a118"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a119"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#methodgetHttpStatusMessage">getHttpStatusMessage</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a120"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a121"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetStatusMessage">getStatusMessage</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a122"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a123"></a> </div></li>
|
|
<li><div class="src-line"><a name="a124"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a125"></a><span class="src-doc"> * Get content type of this Solr response</span></div></li>
|
|
<li><div class="src-line"><a name="a126"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a127"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
|
|
<li><div class="src-line"><a name="a128"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a129"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#methodgetType">getType</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a130"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a131"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetMimeType">getMimeType</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a132"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a133"></a> </div></li>
|
|
<li><div class="src-line"><a name="a134"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a135"></a><span class="src-doc"> * Get character encoding of this response. Should usually be utf-8, but just in case</span></div></li>
|
|
<li><div class="src-line"><a name="a136"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a137"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
|
|
<li><div class="src-line"><a name="a138"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a139"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#methodgetEncoding">getEncoding</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a140"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a141"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetEncoding">getEncoding</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a142"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a143"></a> </div></li>
|
|
<li><div class="src-line"><a name="a144"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a145"></a><span class="src-doc"> * Get the raw response as it was given to this object</span></div></li>
|
|
<li><div class="src-line"><a name="a146"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a147"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
|
|
<li><div class="src-line"><a name="a148"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a149"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#methodgetRawResponse">getRawResponse</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a150"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a151"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetBody">getBody</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a152"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a153"></a> </div></li>
|
|
<li><div class="src-line"><a name="a154"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a155"></a><span class="src-doc"> * Magic get to expose the parsed data and to lazily load it</span></div></li>
|
|
<li><div class="src-line"><a name="a156"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a157"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a158"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
|
|
<li><div class="src-line"><a name="a159"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a160"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#method__get">__get</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a161"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a162"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_isParsed">_isParsed</a><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a163"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a164"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#method_parseData">_parseData</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a165"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_isParsed">_isParsed</a> = <span class="src-id">true</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a166"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a167"></a> </div></li>
|
|
<li><div class="src-line"><a name="a168"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_parsedData">_parsedData</a><span class="src-sym">-></span><span class="src-var">$key</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a169"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a170"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_parsedData">_parsedData</a><span class="src-sym">-></span><span class="src-var">$key</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a171"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a172"></a> </div></li>
|
|
<li><div class="src-line"><a name="a173"></a> <span class="src-key">return </span><span class="src-id">null</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a174"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a175"></a> </div></li>
|
|
<li><div class="src-line"><a name="a176"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a177"></a><span class="src-doc"> * Magic function for isset function on parsed data</span></div></li>
|
|
<li><div class="src-line"><a name="a178"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a179"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$key </span></div></li>
|
|
<li><div class="src-line"><a name="a180"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
|
|
<li><div class="src-line"><a name="a181"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a182"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#method__isset">__isset</a><span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a183"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a184"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_isParsed">_isParsed</a><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a185"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a186"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#method_parseData">_parseData</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a187"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_isParsed">_isParsed</a> = <span class="src-id">true</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a188"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a189"></a> </div></li>
|
|
<li><div class="src-line"><a name="a190"></a> <span class="src-key">return </span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_parsedData">_parsedData</a><span class="src-sym">-></span><span class="src-var">$key</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a191"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a192"></a> </div></li>
|
|
<li><div class="src-line"><a name="a193"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a194"></a><span class="src-doc"> * Parse the raw response into the parsed_data array for access</span></div></li>
|
|
<li><div class="src-line"><a name="a195"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a196"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@throws</span><span class="src-doc"> Apache_Solr_ParserException If the data could not be parsed</span></div></li>
|
|
<li><div class="src-line"><a name="a197"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a198"></a> <span class="src-key">protected </span><span class="src-key">function </span><a href="../Apache/Solr/Apache_Solr_Response.html#method_parseData">_parseData</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a199"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a200"></a> <span class="src-comm">//An alternative would be to use Zend_Json::decode(...)</span></div></li>
|
|
<li><div class="src-line"><a name="a201"></a> <span class="src-var">$data </span>= <a href="http://www.php.net/json_decode">json_decode</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_response">_response</a><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_HttpTransport_Response.html#methodgetBody">getBody</a><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a202"></a> </div></li>
|
|
<li><div class="src-line"><a name="a203"></a> <span class="src-comm">// check that we receive a valid JSON response - we should never receive a null</span></div></li>
|
|
<li><div class="src-line"><a name="a204"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$data </span>=== <span class="src-id">null</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a205"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a206"></a> throw <span class="src-key">new </span><span class="src-id"><a href="../Apache/Solr/Apache_Solr_ParserException.html">Apache_Solr_ParserException</a></span><span class="src-sym">(</span><span class="src-str">'Solr response does not appear to be valid JSON, please examine the raw response with getRawResponse() method'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a207"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a208"></a> </div></li>
|
|
<li><div class="src-line"><a name="a209"></a> <span class="src-comm">//if we're configured to collapse single valued arrays or to convert them to Apache_Solr_Document objects</span></div></li>
|
|
<li><div class="src-line"><a name="a210"></a> <span class="src-comm">//and we have response documents, then try to collapse the values and / or convert them now</span></div></li>
|
|
<li><div class="src-line"><a name="a211"></a> <span class="src-key">if </span><span class="src-sym">((</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_createDocuments">_createDocuments</a> || <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_collapseSingleValueArrays">_collapseSingleValueArrays</a><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">) </span>&& <a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">docs</span><span class="src-sym">))</span></div></li>
|
|
<li><div class="src-line"><a name="a212"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a213"></a> <span class="src-var">$documents </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a214"></a> </div></li>
|
|
<li><div class="src-line"><a name="a215"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">docs </span><span class="src-key">as </span><span class="src-var">$originalDocument</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a216"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a217"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_createDocuments">_createDocuments</a><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a218"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a219"></a> <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"><a name="a220"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a221"></a> <span class="src-key">else</span></div></li>
|
|
<li><div class="src-line"><a name="a222"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a223"></a> <span class="src-var">$document </span>= <span class="src-var">$originalDocument</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a224"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a225"></a> </div></li>
|
|
<li><div class="src-line"><a name="a226"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$originalDocument </span><span class="src-key">as </span><span class="src-var">$key </span>=> <span class="src-var">$value</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a227"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a228"></a> <span class="src-comm">//If a result is an array with only a single</span></div></li>
|
|
<li><div class="src-line"><a name="a229"></a> <span class="src-comm">//value then its nice to be able to access</span></div></li>
|
|
<li><div class="src-line"><a name="a230"></a> <span class="src-comm">//it as if it were always a single value</span></div></li>
|
|
<li><div class="src-line"><a name="a231"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_collapseSingleValueArrays">_collapseSingleValueArrays</a> && <a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">) </span>&& <a href="http://www.php.net/count">count</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">) </span><= <span class="src-num">1</span><span class="src-sym">)</span></div></li>
|
|
<li><div class="src-line"><a name="a232"></a> <span class="src-sym">{</span></div></li>
|
|
<li><div class="src-line"><a name="a233"></a> <span class="src-var">$value </span>= <a href="http://www.php.net/array_shift">array_shift</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a234"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a235"></a> </div></li>
|
|
<li><div class="src-line"><a name="a236"></a> <span class="src-var">$document</span><span class="src-sym">-></span><span class="src-var">$key </span>= <span class="src-var">$value</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a237"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a238"></a> </div></li>
|
|
<li><div class="src-line"><a name="a239"></a> <span class="src-var">$documents</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$document</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a240"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a241"></a> </div></li>
|
|
<li><div class="src-line"><a name="a242"></a> <span class="src-var">$data</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">docs </span>= <span class="src-var">$documents</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a243"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a244"></a> </div></li>
|
|
<li><div class="src-line"><a name="a245"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Apache/Solr/Apache_Solr_Response.html#var$_parsedData">_parsedData</a> = <span class="src-var">$data</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a246"></a> <span class="src-sym">}</span></div></li>
|
|
<li><div class="src-line"><a name="a247"></a><span class="src-sym">}</span></div></li>
|
|
</ol></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>
|
|
</body>
|
|
</html> |