[7576] | 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 | * Terms query result |
---|
| 41 | * |
---|
| 42 | * @package Solarium |
---|
| 43 | * @subpackage Result |
---|
| 44 | */ |
---|
| 45 | class Solarium_Result_Terms extends Solarium_Result_QueryType implements IteratorAggregate, Countable |
---|
| 46 | { |
---|
| 47 | /** |
---|
| 48 | * Status code returned by Solr |
---|
| 49 | * |
---|
| 50 | * @var int |
---|
| 51 | */ |
---|
| 52 | protected $_status; |
---|
| 53 | |
---|
| 54 | /** |
---|
| 55 | * Solr index queryTime |
---|
| 56 | * |
---|
| 57 | * This doesn't include things like the HTTP responsetime. Purely the Solr |
---|
| 58 | * query execution time. |
---|
| 59 | * |
---|
| 60 | * @var int |
---|
| 61 | */ |
---|
| 62 | protected $_queryTime; |
---|
| 63 | |
---|
| 64 | /** |
---|
| 65 | * Term results |
---|
| 66 | * |
---|
| 67 | * @var array |
---|
| 68 | */ |
---|
| 69 | protected $_results; |
---|
| 70 | |
---|
| 71 | /** |
---|
| 72 | * Get Solr status code |
---|
| 73 | * |
---|
| 74 | * This is not the HTTP status code! The normal value for success is 0. |
---|
| 75 | * |
---|
| 76 | * @return int |
---|
| 77 | */ |
---|
| 78 | public function getStatus() |
---|
| 79 | { |
---|
| 80 | $this->_parseResponse(); |
---|
| 81 | |
---|
| 82 | return $this->_status; |
---|
| 83 | } |
---|
| 84 | |
---|
| 85 | /** |
---|
| 86 | * Get Solr query time |
---|
| 87 | * |
---|
| 88 | * This doesn't include things like the HTTP responsetime. Purely the Solr |
---|
| 89 | * query execution time. |
---|
| 90 | * |
---|
| 91 | * @return int |
---|
| 92 | */ |
---|
| 93 | public function getQueryTime() |
---|
| 94 | { |
---|
| 95 | $this->_parseResponse(); |
---|
| 96 | |
---|
| 97 | return $this->_queryTime; |
---|
| 98 | } |
---|
| 99 | |
---|
| 100 | /** |
---|
| 101 | * Get all term results |
---|
| 102 | * |
---|
| 103 | * @return array |
---|
| 104 | */ |
---|
| 105 | public function getResults() |
---|
| 106 | { |
---|
| 107 | $this->_parseResponse(); |
---|
| 108 | |
---|
| 109 | return $this->_results; |
---|
| 110 | } |
---|
| 111 | |
---|
| 112 | /** |
---|
| 113 | * Get term results for a specific field |
---|
| 114 | * |
---|
| 115 | * @param string $field |
---|
| 116 | * @return array |
---|
| 117 | */ |
---|
| 118 | public function getTerms($field) |
---|
| 119 | { |
---|
| 120 | $this->_parseResponse(); |
---|
| 121 | |
---|
| 122 | if (isset($this->_results[$field])) { |
---|
| 123 | return $this->_results[$field]; |
---|
| 124 | } else { |
---|
| 125 | return array(); |
---|
| 126 | } |
---|
| 127 | } |
---|
| 128 | |
---|
| 129 | /** |
---|
| 130 | * IteratorAggregate implementation |
---|
| 131 | * |
---|
| 132 | * @return ArrayIterator |
---|
| 133 | */ |
---|
| 134 | public function getIterator() |
---|
| 135 | { |
---|
| 136 | $this->_parseResponse(); |
---|
| 137 | |
---|
| 138 | return new ArrayIterator($this->_results); |
---|
| 139 | } |
---|
| 140 | |
---|
| 141 | /** |
---|
| 142 | * Countable implementation |
---|
| 143 | * |
---|
| 144 | * @return int |
---|
| 145 | */ |
---|
| 146 | public function count() |
---|
| 147 | { |
---|
| 148 | $this->_parseResponse(); |
---|
| 149 | |
---|
| 150 | return count($this->_results); |
---|
| 151 | } |
---|
| 152 | } |
---|