3 * Represents a filter (used on ChangesListSpecialPage and descendants)
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 * @author Matthew Flaschen
26 * Represents a filter (used on ChangesListSpecialPage and descendants)
30 abstract class ChangesListFilter
{
39 * CSS class suffix used for attribution, e.g. 'bot'.
41 * In this example, if bot actions are included in the result set, this CSS class
42 * will then be included in all bot-flagged actions.
44 * @var string|null $cssClassSuffix
46 protected $cssClassSuffix;
49 * Callable that returns true if and only if a row is attributed to this filter
51 * @var callable $isRowApplicableCallable
53 protected $isRowApplicableCallable;
56 * Group. ChangesListFilterGroup this belongs to
58 * @var ChangesListFilterGroup $group
63 * i18n key of label for structured UI
70 * i18n key of description for structured UI
72 * @var string $description
74 protected $description;
77 * Array of associative arrays with conflict information. See
78 * setUnidirectionalConflict
80 * @var array $conflictingGroups
82 protected $conflictingGroups = [];
85 * Array of associative arrays with conflict information. See
86 * setUnidirectionalConflict
88 * @var array $conflictingFilters
90 protected $conflictingFilters = [];
93 * Array of associative arrays with subset information
95 * @var array $subsetFilters
97 protected $subsetFilters = [];
100 * Priority integer. Higher value means higher up in the group's filter list.
102 * @var string $priority
106 const RESERVED_NAME_CHAR
= '_';
109 * Creates a new filter with the specified configuration, and registers it to the
112 * It infers which UI (it can be either or both) to display the filter on based on
113 * which messages are provided.
115 * If 'label' is provided, it will be displayed on the structured UI. Thus,
116 * 'label', 'description', and sub-class parameters are optional depending on which
119 * @param array $filterDefinition ChangesListFilter definition
120 * * $filterDefinition['name'] string Name of filter; use lowercase with no
122 * * $filterDefinition['cssClassSuffix'] string CSS class suffix, used to mark
123 * that a particular row belongs to this filter (when a row is included by the
125 * * $filterDefinition['isRowApplicableCallable'] Callable taking two parameters, the
126 * IContextSource, and the RecentChange object for the row, and returning true if
127 * the row is attributed to this filter. The above CSS class will then be
128 * automatically added (optional, required if cssClassSuffix is used).
129 * * $filterDefinition['group'] ChangesListFilterGroup Group. Filter group this
131 * * $filterDefinition['label'] string i18n key of label for structured UI.
132 * * $filterDefinition['description'] string i18n key of description for structured
134 * * $filterDefinition['priority'] int Priority integer. Higher value means higher
135 * up in the group's filter list.
137 public function __construct( array $filterDefinition ) {
138 if ( isset( $filterDefinition['group'] ) ) {
139 $this->group
= $filterDefinition['group'];
141 throw new MWException( 'You must use \'group\' to specify the ' .
142 'ChangesListFilterGroup this filter belongs to' );
145 if ( strpos( $filterDefinition['name'], self
::RESERVED_NAME_CHAR
) !== false ) {
146 throw new MWException( 'Filter names may not contain \'' .
147 self
::RESERVED_NAME_CHAR
.
148 '\'. Use the naming convention: \'lowercase\''
152 if ( $this->group
->getFilter( $filterDefinition['name'] ) ) {
153 throw new MWException( 'Two filters in a group cannot have the ' .
154 "same name: '{$filterDefinition['name']}'" );
157 $this->name
= $filterDefinition['name'];
159 if ( isset( $filterDefinition['cssClassSuffix'] ) ) {
160 $this->cssClassSuffix
= $filterDefinition['cssClassSuffix'];
161 $this->isRowApplicableCallable
= $filterDefinition['isRowApplicableCallable'];
164 if ( isset( $filterDefinition['label'] ) ) {
165 $this->label
= $filterDefinition['label'];
166 $this->description
= $filterDefinition['description'];
169 $this->priority
= $filterDefinition['priority'];
171 $this->group
->registerFilter( $this );
175 * Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.
177 * WARNING: This means there is a conflict when both things are *shown*
178 * (not filtered out), even for the hide-based filters. So e.g. conflicting with
179 * 'hideanons' means there is a conflict if only anonymous users are *shown*.
181 * @param ChangesListFilterGroup|ChangesListFilter $other Other
182 * ChangesListFilterGroup or ChangesListFilter
183 * @param string $globalKey i18n key for top-level conflict message
184 * @param string $forwardKey i18n key for conflict message in this
185 * direction (when in UI context of $this object)
186 * @param string $backwardKey i18n key for conflict message in reverse
187 * direction (when in UI context of $other object)
189 public function conflictsWith( $other, $globalKey, $forwardKey,
192 if ( $globalKey === null ||
$forwardKey === null ||
193 $backwardKey === null ) {
195 throw new MWException( 'All messages must be specified' );
198 $this->setUnidirectionalConflict(
204 $other->setUnidirectionalConflict(
212 * Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with
217 * @param ChangesListFilterGroup|ChangesListFilter $other Other
218 * ChangesListFilterGroup or ChangesListFilter
219 * @param string $globalDescription i18n key for top-level conflict message
220 * @param string $contextDescription i18n key for conflict message in this
221 * direction (when in UI context of $this object)
223 public function setUnidirectionalConflict( $other, $globalDescription,
224 $contextDescription ) {
226 if ( $other instanceof ChangesListFilterGroup
) {
227 $this->conflictingGroups
[] = [
228 'group' => $other->getName(),
229 'groupObject' => $other,
230 'globalDescription' => $globalDescription,
231 'contextDescription' => $contextDescription,
233 } elseif ( $other instanceof ChangesListFilter
) {
234 $this->conflictingFilters
[] = [
235 'group' => $other->getGroup()->getName(),
236 'filter' => $other->getName(),
237 'filterObject' => $other,
238 'globalDescription' => $globalDescription,
239 'contextDescription' => $contextDescription,
242 throw new MWException( 'You can only pass in a ChangesListFilterGroup or a ChangesListFilter' );
247 * Marks that the current instance is (also) a superset of the filter passed in.
248 * This can be called more than once.
250 * This means that anything in the results for the other filter is also in the
251 * results for this one.
253 * @param ChangesListFilter $other The filter the current instance is a superset of
255 public function setAsSupersetOf( ChangesListFilter
$other ) {
256 if ( $other->getGroup() !== $this->getGroup() ) {
257 throw new MWException( 'Supersets can only be defined for filters in the same group' );
260 $this->subsetFilters
[] = [
261 // It's always the same group, but this makes the representation
262 // more consistent with conflicts.
263 'group' => $other->getGroup()->getName(),
264 'filter' => $other->getName(),
269 * @return string Name, e.g. hideanons
271 public function getName() {
276 * @return ChangesListFilterGroup Group this belongs to
278 public function getGroup() {
283 * @return string i18n key of label for structured UI
285 public function getLabel() {
290 * @return string i18n key of description for structured UI
292 public function getDescription() {
293 return $this->description
;
297 * Checks whether the filter should display on the unstructured UI
299 * @return bool Whether to display
301 abstract public function displaysOnUnstructuredUi();
304 * Checks whether the filter should display on the structured UI
305 * This refers to the exact filter. See also isFeatureAvailableOnStructuredUi.
307 * @return bool Whether to display
309 public function displaysOnStructuredUi() {
310 return $this->label
!== null;
314 * Checks whether an equivalent feature for this filter is available on the
317 * This can either be the exact filter, or a new filter that replaces it.
319 public function isFeatureAvailableOnStructuredUi() {
320 return $this->displaysOnStructuredUi();
324 * @return int Priority. Higher value means higher up in the group list
326 public function getPriority() {
327 return $this->priority
;
333 * @return string|null CSS class, or null if not defined
335 protected function getCssClass() {
336 if ( $this->cssClassSuffix
!== null ) {
337 return ChangesList
::CSS_CLASS_PREFIX
. $this->cssClassSuffix
;
344 * Add CSS class if needed
346 * @param IContextSource $ctx Context source
347 * @param RecentChange $rc Recent changes object
348 * @param array &$classes Non-associative array of CSS class names; appended to if needed
350 public function applyCssClassIfNeeded( IContextSource
$ctx, RecentChange
$rc, array &$classes ) {
351 if ( $this->isRowApplicableCallable
=== null ) {
355 if ( call_user_func( $this->isRowApplicableCallable
, $ctx, $rc ) ) {
356 $classes[] = $this->getCssClass();
361 * Gets the JS data required by the front-end of the structured UI
363 * @return array Associative array Data required by the front-end. messageKeys is
364 * a special top-level value, with the value being an array of the message keys to
365 * send to the client.
367 public function getJsData() {
369 'name' => $this->getName(),
370 'label' => $this->getLabel(),
371 'description' => $this->getDescription(),
372 'cssClass' => $this->getCssClass(),
373 'priority' => $this->priority
,
374 'subset' => $this->subsetFilters
,
378 $output['messageKeys'] = [
380 $this->getDescription(),
383 $conflicts = array_merge(
384 $this->conflictingGroups
,
385 $this->conflictingFilters
388 foreach ( $conflicts as $conflictInfo ) {
389 unset( $conflictInfo['filterObject'] );
390 unset( $conflictInfo['groupObject'] );
391 $output['conflicts'][] = $conflictInfo;
393 $output['messageKeys'],
394 $conflictInfo['globalDescription'],
395 $conflictInfo['contextDescription']
403 * Checks whether this filter is selected in the provided options
405 * @param FormOptions $opts
408 abstract public function isSelected( FormOptions
$opts );
411 * Get groups conflicting with this filter
413 * @return ChangesListFilterGroup[]
415 public function getConflictingGroups() {
417 function ( $conflictDesc ) {
418 return $conflictDesc[ 'groupObject' ];
420 $this->conflictingGroups
425 * Get filters conflicting with this filter
427 * @return ChangesListFilter[]
429 public function getConflictingFilters() {
431 function ( $conflictDesc ) {
432 return $conflictDesc[ 'filterObject' ];
434 $this->conflictingFilters
439 * Check if the conflict with a group is currently "active"
441 * @param ChangesListFilterGroup $group
442 * @param FormOptions $opts
445 public function activelyInConflictWithGroup( ChangesListFilterGroup
$group, FormOptions
$opts ) {
446 if ( $group->anySelected( $opts ) && $this->isSelected( $opts ) ) {
447 /** @var ChangesListFilter $siblingFilter */
448 foreach ( $this->getSiblings() as $siblingFilter ) {
449 if ( $siblingFilter->isSelected( $opts ) && !$siblingFilter->hasConflictWithGroup( $group ) ) {
458 private function hasConflictWithGroup( ChangesListFilterGroup
$group ) {
459 return in_array( $group, $this->getConflictingGroups() );
463 * Check if the conflict with a filter is currently "active"
465 * @param ChangesListFilter $filter
466 * @param FormOptions $opts
469 public function activelyInConflictWithFilter( ChangeslistFilter
$filter, FormOptions
$opts ) {
470 if ( $this->isSelected( $opts ) && $filter->isSelected( $opts ) ) {
471 /** @var ChangesListFilter $siblingFilter */
472 foreach ( $this->getSiblings() as $siblingFilter ) {
474 $siblingFilter->isSelected( $opts ) &&
475 !$siblingFilter->hasConflictWithFilter( $filter )
485 private function hasConflictWithFilter( ChangeslistFilter
$filter ) {
486 return in_array( $filter, $this->getConflictingFilters() );
490 * Get filters in the same group
492 * @return ChangesListFilter[]
494 protected function getSiblings() {
496 $this->getGroup()->getFilters(),
497 function ( $filter ) {
498 return $filter !== $this;