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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<?php
/**
* Represents a hide-based boolean filter (used on ChangesListSpecialPage and descendants)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Matthew Flaschen
*/
use Wikimedia\Rdbms\IDatabase;
/**
* Represents a hide-based boolean filter (used on ChangesListSpecialPage and descendants)
*
* @since 1.29
*/
class ChangesListBooleanFilter extends ChangesListFilter {
// This can sometimes be different on Special:RecentChanges
// and Special:Watchlist, due to the double-legacy hooks
// (SpecialRecentChangesFilters and SpecialWatchlistFilters)
// but there will be separate sets of ChangesListFilterGroup and ChangesListFilter instances
// for those pages (it should work even if they're both loaded
// at once, but that can't happen).
/**
* Main unstructured UI i18n key
*
* @var string $showHide
*/
protected $showHide;
/**
* Whether there is a feature designed to replace this filter available on the
* structured UI
*
* @var bool $isReplacedInStructuredUi
*/
protected $isReplacedInStructuredUi;
/**
* Default
*
* @var bool $defaultValue
*/
protected $defaultValue;
/**
* Callable used to do the actual query modification; see constructor
*
* @var callable $queryCallable
*/
protected $queryCallable;
/**
* Value that defined when this filter is considered active
*
* @var bool $activeValue
*/
protected $activeValue;
/**
* Create a new filter with the specified configuration.
*
* It infers which UI (it can be either or both) to display the filter on based on
* which messages are provided.
*
* If 'label' is provided, it will be displayed on the structured UI. If
* 'showHide' is provided, it will be displayed on the unstructured UI. Thus,
* 'label', 'description', and 'showHide' are optional depending on which UI
* it's for.
*
* @param array $filterDefinition ChangesListFilter definition
* * $filterDefinition['name'] string Name. Used as URL parameter.
* * $filterDefinition['group'] ChangesListFilterGroup Group. Filter group this
* belongs to.
* * $filterDefinition['label'] string i18n key of label for structured UI.
* * $filterDefinition['description'] string i18n key of description for structured
* UI.
* * $filterDefinition['showHide'] string Main i18n key used for unstructured UI.
* * $filterDefinition['isReplacedInStructuredUi'] bool Whether there is an
* equivalent feature available in the structured UI; this is optional, defaulting
* to true. It does not need to be set if the exact same filter is simply visible
* on both.
* * $filterDefinition['default'] bool Default
* * $filterDefinition['activeValue'] bool This filter is considered active when
* its value is equal to its activeValue. Default is true.
* * $filterDefinition['priority'] int Priority integer. Higher value means higher
* up in the group's filter list.
* * $filterDefinition['queryCallable'] callable Callable accepting parameters, used
* to implement filter's DB query modification. Required, except for legacy
* filters that still use the query hooks directly. Callback parameters:
* * string $specialPageClassName Class name of current special page
* * IContextSource $context Context, for e.g. user
* * IDatabase $dbr Database, for addQuotes, makeList, and similar
* * array &$tables Array of tables; see IDatabase::select $table
* * array &$fields Array of fields; see IDatabase::select $vars
* * array &$conds Array of conditions; see IDatabase::select $conds
* * array &$query_options Array of query options; see IDatabase::select $options
* * array &$join_conds Array of join conditions; see IDatabase::select $join_conds
*/
public function __construct( $filterDefinition ) {
parent::__construct( $filterDefinition );
if ( isset( $filterDefinition['showHide'] ) ) {
$this->showHide = $filterDefinition['showHide'];
}
if ( isset( $filterDefinition['isReplacedInStructuredUi'] ) ) {
$this->isReplacedInStructuredUi = $filterDefinition['isReplacedInStructuredUi'];
} else {
$this->isReplacedInStructuredUi = false;
}
if ( isset( $filterDefinition['default'] ) ) {
$this->setDefault( $filterDefinition['default'] );
} else {
throw new MWException( 'You must set a default' );
}
if ( isset( $filterDefinition['queryCallable'] ) ) {
$this->queryCallable = $filterDefinition['queryCallable'];
}
if ( isset( $filterDefinition['activeValue'] ) ) {
$this->activeValue = $filterDefinition['activeValue'];
} else {
$this->activeValue = true;
}
}
/**
* Get the default value
*
* @param bool $structuredUI Are we currently showing the structured UI
* @return bool|null Default value
*/
public function getDefault( $structuredUI = false ) {
return $this->isReplacedInStructuredUi && $structuredUI ?
!$this->activeValue :
$this->defaultValue;
}
/**
* Sets default. It must be a boolean.
*
* It will be coerced to boolean.
*
* @param bool $defaultValue
*/
public function setDefault( $defaultValue ) {
$this->defaultValue = (bool)$defaultValue;
}
/**
* @return string Main i18n key for unstructured UI
*/
public function getShowHide() {
return $this->showHide;
}
/**
* @inheritDoc
*/
public function displaysOnUnstructuredUi() {
return !!$this->showHide;
}
/**
* @inheritDoc
*/
public function isFeatureAvailableOnStructuredUi() {
return $this->isReplacedInStructuredUi ||
parent::isFeatureAvailableOnStructuredUi();
}
/**
* Modifies the query to include the filter. This is only called if the filter is
* in effect (taking into account the default).
*
* @param IDatabase $dbr Database, for addQuotes, makeList, and similar
* @param ChangesListSpecialPage $specialPage Current special page
* @param array &$tables Array of tables; see IDatabase::select $table
* @param array &$fields Array of fields; see IDatabase::select $vars
* @param array &$conds Array of conditions; see IDatabase::select $conds
* @param array &$query_options Array of query options; see IDatabase::select $options
* @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
*/
public function modifyQuery( IDatabase $dbr, ChangesListSpecialPage $specialPage,
&$tables, &$fields, &$conds, &$query_options, &$join_conds
) {
if ( $this->queryCallable === null ) {
return;
}
call_user_func_array(
$this->queryCallable,
[
get_class( $specialPage ),
$specialPage->getContext(),
$dbr,
&$tables,
&$fields,
&$conds,
&$query_options,
&$join_conds
]
);
}
/**
* @inheritDoc
*/
public function getJsData() {
$output = parent::getJsData();
$output['default'] = $this->defaultValue;
return $output;
}
/**
* @inheritDoc
*/
public function isSelected( FormOptions $opts ) {
return !$opts[ $this->getName() ] &&
array_filter(
$this->getSiblings(),
function ( ChangesListBooleanFilter $sibling ) use ( $opts ) {
return $opts[ $sibling->getName() ];
}
);
}
/**
* @param FormOptions $opts Query parameters merged with defaults
* @param bool $isStructuredUI Whether the structured UI is currently enabled
* @return bool Whether this filter should be considered active
*/
public function isActive( FormOptions $opts, $isStructuredUI ) {
if ( $this->isReplacedInStructuredUi && $isStructuredUI ) {
return false;
}
return $opts[ $this->getName() ] === $this->activeValue;
}
}
|
