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 grouping field value group result |
---|
41 | * |
---|
42 | * @since 2.1.0 |
---|
43 | * |
---|
44 | * @package Solarium |
---|
45 | * @subpackage Result |
---|
46 | */ |
---|
47 | class Solarium_Result_Select_Grouping_ValueGroup implements IteratorAggregate, Countable |
---|
48 | { |
---|
49 | |
---|
50 | /** |
---|
51 | * Field value |
---|
52 | * |
---|
53 | * @var string |
---|
54 | */ |
---|
55 | protected $_value; |
---|
56 | |
---|
57 | /** |
---|
58 | * NumFound |
---|
59 | * |
---|
60 | * @var int |
---|
61 | */ |
---|
62 | protected $_numFound; |
---|
63 | |
---|
64 | /** |
---|
65 | * Start position |
---|
66 | * |
---|
67 | * @var int |
---|
68 | */ |
---|
69 | protected $_start; |
---|
70 | |
---|
71 | /** |
---|
72 | * Documents in this group |
---|
73 | * |
---|
74 | * @var array |
---|
75 | */ |
---|
76 | protected $_documents; |
---|
77 | |
---|
78 | /** |
---|
79 | * Constructor |
---|
80 | * |
---|
81 | * @param string $value |
---|
82 | * @param int $numFound |
---|
83 | * @param int $start |
---|
84 | * @param array $documents |
---|
85 | * @return void |
---|
86 | */ |
---|
87 | public function __construct($value, $numFound, $start, $documents) |
---|
88 | { |
---|
89 | $this->_value = $value; |
---|
90 | $this->_numFound = $numFound; |
---|
91 | $this->_start = $start; |
---|
92 | $this->_documents = $documents; |
---|
93 | } |
---|
94 | |
---|
95 | /** |
---|
96 | * Get value |
---|
97 | * |
---|
98 | * @return string |
---|
99 | */ |
---|
100 | public function getValue() |
---|
101 | { |
---|
102 | return $this->_value; |
---|
103 | } |
---|
104 | |
---|
105 | /** |
---|
106 | * Get numFound |
---|
107 | * |
---|
108 | * @return int |
---|
109 | */ |
---|
110 | public function getNumFound() |
---|
111 | { |
---|
112 | return $this->_numFound; |
---|
113 | } |
---|
114 | |
---|
115 | /** |
---|
116 | * Get start |
---|
117 | * |
---|
118 | * @return int |
---|
119 | */ |
---|
120 | public function getStart() |
---|
121 | { |
---|
122 | return $this->_start; |
---|
123 | } |
---|
124 | |
---|
125 | /** |
---|
126 | * Get all documents |
---|
127 | * |
---|
128 | * @return array |
---|
129 | */ |
---|
130 | public function getDocuments() |
---|
131 | { |
---|
132 | return $this->_documents; |
---|
133 | } |
---|
134 | |
---|
135 | /** |
---|
136 | * IteratorAggregate implementation |
---|
137 | * |
---|
138 | * @return ArrayIterator |
---|
139 | */ |
---|
140 | public function getIterator() |
---|
141 | { |
---|
142 | return new ArrayIterator($this->_documents); |
---|
143 | } |
---|
144 | |
---|
145 | /** |
---|
146 | * Countable implementation |
---|
147 | * |
---|
148 | * @return int |
---|
149 | */ |
---|
150 | public function count() |
---|
151 | { |
---|
152 | return count($this->_documents); |
---|
153 | } |
---|
154 | } |
---|