[7588] | 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 spellcheck result |
---|
| 41 | * |
---|
| 42 | * @package Solarium |
---|
| 43 | * @subpackage Result |
---|
| 44 | */ |
---|
| 45 | class Solarium_Result_Select_Spellcheck implements IteratorAggregate, Countable |
---|
| 46 | { |
---|
| 47 | |
---|
| 48 | /** |
---|
| 49 | * Suggestions array |
---|
| 50 | * |
---|
| 51 | * @var array |
---|
| 52 | */ |
---|
| 53 | protected $_suggestions; |
---|
| 54 | |
---|
| 55 | /** |
---|
| 56 | * Collation object |
---|
| 57 | * |
---|
| 58 | * @var Solarium_Result_Select_Spellcheck_Collation |
---|
| 59 | */ |
---|
| 60 | protected $_collation; |
---|
| 61 | |
---|
| 62 | /** |
---|
| 63 | * Correctly spelled? |
---|
| 64 | * |
---|
| 65 | * @var boolean |
---|
| 66 | */ |
---|
| 67 | protected $_correctlySpelled; |
---|
| 68 | |
---|
| 69 | /** |
---|
| 70 | * Constructor |
---|
| 71 | * |
---|
| 72 | * @param array $suggestions |
---|
| 73 | * @param Solarium_Result_Select_Spellcheck_Collation $collation |
---|
| 74 | * @param boolean $correctlySpelled |
---|
| 75 | * @return void |
---|
| 76 | */ |
---|
| 77 | public function __construct($suggestions, $collation, $correctlySpelled) |
---|
| 78 | { |
---|
| 79 | $this->_suggestions = $suggestions; |
---|
| 80 | $this->_collation = $collation; |
---|
| 81 | $this->_correctlySpelled = $correctlySpelled; |
---|
| 82 | } |
---|
| 83 | |
---|
| 84 | /** |
---|
| 85 | * Get the collation result |
---|
| 86 | * |
---|
| 87 | * @return Solarium_Result_Select_Spellcheck_Collation |
---|
| 88 | */ |
---|
| 89 | public function getCollation() |
---|
| 90 | { |
---|
| 91 | return $this->_collation; |
---|
| 92 | } |
---|
| 93 | |
---|
| 94 | /** |
---|
| 95 | * Get correctly spelled status |
---|
| 96 | * |
---|
| 97 | * Only available if ExtendedResults was enabled in your query |
---|
| 98 | * |
---|
| 99 | * @return bool |
---|
| 100 | */ |
---|
| 101 | public function getCorrectlySpelled() |
---|
| 102 | { |
---|
| 103 | return $this->_correctlySpelled; |
---|
| 104 | } |
---|
| 105 | |
---|
| 106 | /** |
---|
| 107 | * Get a result by key |
---|
| 108 | * |
---|
| 109 | * @param mixed $key |
---|
| 110 | * @return Solarium_Result_Select_Highlighting_Suggestion|null |
---|
| 111 | */ |
---|
| 112 | public function getSuggestion($key) |
---|
| 113 | { |
---|
| 114 | if (isset($this->_suggestions[$key])) { |
---|
| 115 | return $this->_suggestions[$key]; |
---|
| 116 | } else { |
---|
| 117 | return null; |
---|
| 118 | } |
---|
| 119 | } |
---|
| 120 | |
---|
| 121 | /** |
---|
| 122 | * Get all suggestions |
---|
| 123 | * |
---|
| 124 | * @return array |
---|
| 125 | */ |
---|
| 126 | public function getSuggestions() |
---|
| 127 | { |
---|
| 128 | return $this->_suggestions; |
---|
| 129 | } |
---|
| 130 | |
---|
| 131 | /** |
---|
| 132 | * IteratorAggregate implementation |
---|
| 133 | * |
---|
| 134 | * @return ArrayIterator |
---|
| 135 | */ |
---|
| 136 | public function getIterator() |
---|
| 137 | { |
---|
| 138 | return new ArrayIterator($this->_suggestions); |
---|
| 139 | } |
---|
| 140 | |
---|
| 141 | /** |
---|
| 142 | * Countable implementation |
---|
| 143 | * |
---|
| 144 | * @return int |
---|
| 145 | */ |
---|
| 146 | public function count() |
---|
| 147 | { |
---|
| 148 | return count($this->_suggestions); |
---|
| 149 | } |
---|
| 150 | } |
---|