/
Query.php
165 lines (150 loc) · 4.7 KB
/
Query.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?php
/**
* Copyright 2014 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @link http://www.solarium-project.org/
*/
/**
* @namespace
*/
namespace Solarium\Plugin\MinimumScoreFilter;
use Solarium\QueryType\Select\Query\Query as SelectQuery;
/**
* MinimumScoreFilter Query.
*
* Extends the standard select query and adds functionality for the minimumscore filter
*/
class Query extends SelectQuery
{
/**
* Filter mode mark documents.
*/
const FILTER_MODE_MARK = 'mark';
/**
* Filter mode remove documents.
*/
const FILTER_MODE_REMOVE = 'remove';
/**
* Default options.
*
* @var array
*/
protected $options = array(
'handler' => 'select',
'resultclass' => 'Solarium\QueryType\Select\Result\Result',
'documentclass' => 'Solarium\QueryType\Select\Result\Document',
'query' => '*:*',
'start' => 0,
'rows' => 10,
'fields' => '*,score',
'omitheader' => true,
'filterratio' => 0.1,
'filter_mode' => self::FILTER_MODE_REMOVE,
);
/**
* Set filter mode.
*
* @param string $mode
*
* @return self Provides fluent interface
*/
public function setFilterMode($mode)
{
return $this->setOption('filter_mode', $mode);
}
/**
* Get filter mode.
*
* @return string
*/
public function getFilterMode()
{
return $this->getOption('filter_mode');
}
/**
* Set filterratio option.
*
* This should be a ratio between 0 and 1, the minimum score is calculated by multiplying maxscore with this ratio.
*
* @param float $value
*
* @return self Provides fluent interface
*/
public function setFilterRatio($value)
{
return $this->setOption('filterratio', $value);
}
/**
* Get filterratio option.
*
* @return float
*/
public function getFilterRatio()
{
return $this->getOption('filterratio');
}
/**
* Make sure the score field is always enabled.
*
* @return array
*/
public function getFields()
{
$fields = parent::getFields();
if (!in_array('score', $fields)) {
$fields[] = 'score';
}
return $fields;
}
/**
* Make sure the filtering result class is always used.
*
* @return string
*/
public function getResultClass()
{
return 'Solarium\Plugin\MinimumScoreFilter\Result';
}
/**
* Get all registered components.
*
* @return AbstractComponent[]
*/
public function getComponents()
{
if (isset($this->components[self::COMPONENT_GROUPING])) {
$this->components[self::COMPONENT_GROUPING]->setOption('resultquerygroupclass', 'Solarium\Plugin\MinimumScoreFilter\QueryGroupResult');
$this->components[self::COMPONENT_GROUPING]->setOption('resultvaluegroupclass', 'Solarium\Plugin\MinimumScoreFilter\ValueGroupResult');
}
return parent::getComponents();
}
}