1 | <?php |
---|
2 | /** |
---|
3 | * Copyright 2011 Bas de Nooijer. All rights reserved. |
---|
4 | * |
---|
5 | * Redistribution and use in source and binary forms, with or without |
---|
6 | * modification, are permitted provided that the following conditions are met: |
---|
7 | * |
---|
8 | * 1. Redistributions of source code must retain the above copyright notice, |
---|
9 | * this list of conditions and the following disclaimer. |
---|
10 | * |
---|
11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
---|
12 | * this listof conditions and the following disclaimer in the documentation |
---|
13 | * and/or other materials provided with the distribution. |
---|
14 | * |
---|
15 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" |
---|
16 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
17 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
18 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
---|
19 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
20 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
21 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
24 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
25 | * POSSIBILITY OF SUCH DAMAGE. |
---|
26 | * |
---|
27 | * The views and conclusions contained in the software and documentation are |
---|
28 | * those of the authors and should not be interpreted as representing official |
---|
29 | * policies, either expressed or implied, of the copyright holder. |
---|
30 | * |
---|
31 | * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl> |
---|
32 | * @license http://github.com/basdenooijer/solarium/raw/master/COPYING |
---|
33 | * @link http://www.solarium-project.org/ |
---|
34 | * |
---|
35 | * @package Solarium |
---|
36 | * @subpackage Result |
---|
37 | */ |
---|
38 | |
---|
39 | /** |
---|
40 | * Query result |
---|
41 | * |
---|
42 | * This base class provides access to the response and decoded data. If you need more functionality |
---|
43 | * like resultset parsing use one of the subclasses |
---|
44 | * |
---|
45 | * @package Solarium |
---|
46 | * @subpackage Result |
---|
47 | */ |
---|
48 | class Solarium_Result |
---|
49 | { |
---|
50 | |
---|
51 | /** |
---|
52 | * Response object |
---|
53 | * |
---|
54 | * @var Solarium_Client_Response |
---|
55 | */ |
---|
56 | protected $_response; |
---|
57 | |
---|
58 | /** |
---|
59 | * Decode response data |
---|
60 | * |
---|
61 | * This is lazy loaded, {@link getData()} |
---|
62 | * |
---|
63 | * @var array |
---|
64 | */ |
---|
65 | protected $_data; |
---|
66 | |
---|
67 | /** |
---|
68 | * Query used for this request |
---|
69 | * |
---|
70 | * @var Solarium_Query |
---|
71 | */ |
---|
72 | protected $_query; |
---|
73 | |
---|
74 | /** |
---|
75 | * Solarium client instance |
---|
76 | * |
---|
77 | * @var Solarium_Client |
---|
78 | */ |
---|
79 | protected $_client; |
---|
80 | |
---|
81 | /** |
---|
82 | * Constructor |
---|
83 | * |
---|
84 | * @param Solarium_Client $client |
---|
85 | * @param Solarium_Query $query |
---|
86 | * @param Solarium_Client_Response $response |
---|
87 | * @return void |
---|
88 | */ |
---|
89 | public function __construct($client, $query, $response) |
---|
90 | { |
---|
91 | $this->_client = $client; |
---|
92 | $this->_query = $query; |
---|
93 | $this->_response = $response; |
---|
94 | |
---|
95 | // check status for error (range of 400 and 500) |
---|
96 | $statusNum = floor($response->getStatusCode() / 100); |
---|
97 | if ($statusNum == 4 || $statusNum == 5) { |
---|
98 | throw new Solarium_Client_HttpException( |
---|
99 | $response->getStatusMessage(), |
---|
100 | $response->getStatusCode() |
---|
101 | ); |
---|
102 | } |
---|
103 | } |
---|
104 | |
---|
105 | /** |
---|
106 | * Get response object |
---|
107 | * |
---|
108 | * This is the raw HTTP response object, not the parsed data! |
---|
109 | * |
---|
110 | * @return Solarium_Client_Response |
---|
111 | */ |
---|
112 | public function getResponse() |
---|
113 | { |
---|
114 | return $this->_response; |
---|
115 | } |
---|
116 | |
---|
117 | /** |
---|
118 | * Get query instance |
---|
119 | * |
---|
120 | * @return Solarium_Query |
---|
121 | */ |
---|
122 | public function getQuery() |
---|
123 | { |
---|
124 | return $this->_query; |
---|
125 | } |
---|
126 | |
---|
127 | /** |
---|
128 | * Get Solr response data |
---|
129 | * |
---|
130 | * Includes a lazy loading mechanism: JSON body data is decoded on first use and then saved for reuse. |
---|
131 | * |
---|
132 | * @return array |
---|
133 | */ |
---|
134 | public function getData() |
---|
135 | { |
---|
136 | if (null == $this->_data) { |
---|
137 | $this->_data = json_decode($this->_response->getBody(), true); |
---|
138 | if (null === $this->_data) { |
---|
139 | throw new Solarium_Exception( |
---|
140 | 'Solr JSON response could not be decoded' |
---|
141 | ); |
---|
142 | } |
---|
143 | } |
---|
144 | |
---|
145 | return $this->_data; |
---|
146 | } |
---|
147 | } |
---|