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 | * Select component morelikethis result item |
---|
41 | * |
---|
42 | * @package Solarium |
---|
43 | * @subpackage Result |
---|
44 | */ |
---|
45 | class Solarium_Result_Select_MoreLikeThis_Result |
---|
46 | implements IteratorAggregate, Countable |
---|
47 | { |
---|
48 | |
---|
49 | /** |
---|
50 | * Document instances array |
---|
51 | * |
---|
52 | * @var array |
---|
53 | */ |
---|
54 | protected $_documents; |
---|
55 | |
---|
56 | /** |
---|
57 | * Solr numFound |
---|
58 | * |
---|
59 | * This is NOT the number of MLT documents fetched from Solr! |
---|
60 | * |
---|
61 | * @var int |
---|
62 | */ |
---|
63 | protected $_numFound; |
---|
64 | |
---|
65 | /** |
---|
66 | * Maximum score in this MLT set |
---|
67 | * |
---|
68 | * @var float |
---|
69 | */ |
---|
70 | protected $_maximumScore; |
---|
71 | |
---|
72 | /** |
---|
73 | * Constructor |
---|
74 | * |
---|
75 | * @param int $numFound |
---|
76 | * @param float $maxScore |
---|
77 | * @param array $documents |
---|
78 | * @return void |
---|
79 | */ |
---|
80 | public function __construct($numFound, $maxScore, $documents) |
---|
81 | { |
---|
82 | $this->_numFound = $numFound; |
---|
83 | $this->_maximumScore = $maxScore; |
---|
84 | $this->_documents = $documents; |
---|
85 | } |
---|
86 | |
---|
87 | /** |
---|
88 | * get Solr numFound |
---|
89 | * |
---|
90 | * Returns the number of MLT documents found by Solr (this is NOT the |
---|
91 | * number of documents fetched from Solr!) |
---|
92 | * |
---|
93 | * @return int |
---|
94 | */ |
---|
95 | public function getNumFound() |
---|
96 | { |
---|
97 | return $this->_numFound; |
---|
98 | } |
---|
99 | |
---|
100 | /** |
---|
101 | * Get maximum score in the MLT document set |
---|
102 | * |
---|
103 | * @return float |
---|
104 | */ |
---|
105 | public function getMaximumScore() |
---|
106 | { |
---|
107 | return $this->_maximumScore; |
---|
108 | } |
---|
109 | |
---|
110 | /** |
---|
111 | * Get all documents |
---|
112 | * |
---|
113 | * @return array |
---|
114 | */ |
---|
115 | public function getDocuments() |
---|
116 | { |
---|
117 | return $this->_documents; |
---|
118 | } |
---|
119 | |
---|
120 | |
---|
121 | /** |
---|
122 | * IteratorAggregate implementation |
---|
123 | * |
---|
124 | * @return ArrayIterator |
---|
125 | */ |
---|
126 | public function getIterator() |
---|
127 | { |
---|
128 | return new ArrayIterator($this->_documents); |
---|
129 | } |
---|
130 | |
---|
131 | /** |
---|
132 | * Countable implementation |
---|
133 | * |
---|
134 | * @return int |
---|
135 | */ |
---|
136 | public function count() |
---|
137 | { |
---|
138 | return count($this->_documents); |
---|
139 | } |
---|
140 | } |
---|