3 * View model for the filters selection and display
5 * @mixins OO.EventEmitter
6 * @mixins OO.EmitterList
10 mw
.rcfilters
.dm
.FiltersViewModel
= function MwRcfiltersDmFiltersViewModel() {
12 OO
.EventEmitter
.call( this );
13 OO
.EmitterList
.call( this );
16 this.defaultParams
= {};
17 this.defaultFiltersEmpty
= null;
18 this.highlightEnabled
= false;
19 this.invertedNamespaces
= false;
20 this.parameterMap
= {};
23 this.currentView
= 'default';
26 this.aggregate( { update
: 'filterItemUpdate' } );
27 this.connect( this, { filterItemUpdate
: [ 'emit', 'itemUpdate' ] } );
31 OO
.initClass( mw
.rcfilters
.dm
.FiltersViewModel
);
32 OO
.mixinClass( mw
.rcfilters
.dm
.FiltersViewModel
, OO
.EventEmitter
);
33 OO
.mixinClass( mw
.rcfilters
.dm
.FiltersViewModel
, OO
.EmitterList
);
40 * Filter list is initialized
46 * Model has been updated
51 * @param {mw.rcfilters.dm.FilterItem} item Filter item updated
53 * Filter item has changed
57 * @event highlightChange
58 * @param {boolean} Highlight feature is enabled
60 * Highlight feature has been toggled enabled or disabled
65 * @param {boolean} isInverted Namespace selected is inverted
67 * Namespace selection is inverted or straight forward
73 * Re-assess the states of filter items based on the interactions between them
75 * @param {mw.rcfilters.dm.FilterItem} [item] Changed item. If not given, the
76 * method will go over the state of all items
78 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.reassessFilterInteractions = function ( item
) {
81 iterationItems
= item
!== undefined ? [ item
] : this.getItems();
83 iterationItems
.forEach( function ( checkedItem
) {
84 var allCheckedItems
= checkedItem
.getSubset().concat( [ checkedItem
.getName() ] ),
85 groupModel
= checkedItem
.getGroupModel();
87 // Check for subsets (included filters) plus the item itself:
88 allCheckedItems
.forEach( function ( filterItemName
) {
89 var itemInSubset
= model
.getItemByName( filterItemName
);
91 itemInSubset
.toggleIncluded(
92 // If any of itemInSubset's supersets are selected, this item
94 itemInSubset
.getSuperset().some( function ( supersetName
) {
95 return ( model
.getItemByName( supersetName
).isSelected() );
100 // Update coverage for the changed group
101 if ( groupModel
.isFullCoverage() ) {
102 allSelected
= groupModel
.areAllSelected();
103 groupModel
.getItems().forEach( function ( filterItem
) {
104 filterItem
.toggleFullyCovered( allSelected
);
109 // Check for conflicts
110 // In this case, we must go over all items, since
111 // conflicts are bidirectional and depend not only on
112 // individual items, but also on the selected states of
113 // the groups they're in.
114 this.getItems().forEach( function ( filterItem
) {
115 var inConflict
= false,
116 filterItemGroup
= filterItem
.getGroupModel();
118 // For each item, see if that item is still conflicting
119 $.each( model
.groups
, function ( groupName
, groupModel
) {
120 if ( filterItem
.getGroupName() === groupName
) {
121 // Check inside the group
122 inConflict
= groupModel
.areAnySelectedInConflictWith( filterItem
);
124 // According to the spec, if two items conflict from two different
125 // groups, the conflict only lasts if the groups **only have selected
126 // items that are conflicting**. If a group has selected items that
127 // are conflicting and non-conflicting, the scope of the result has
128 // expanded enough to completely remove the conflict.
130 // For example, see two groups with conflicts:
133 // name: 'experienced',
134 // conflicts: [ 'unregistered' ]
139 // name: 'registered',
142 // name: 'unregistered',
145 // If we select 'experienced', then 'unregistered' is in conflict (and vice versa),
146 // because, inherently, 'experienced' filter only includes registered users, and so
147 // both filters are in conflict with one another.
148 // However, the minute we select 'registered', the scope of our results
149 // has expanded to no longer have a conflict with 'experienced' filter, and
150 // so the conflict is removed.
152 // In our case, we need to check if the entire group conflicts with
153 // the entire item's group, so we follow the above spec
155 // The foreign group is in conflict with this item
156 groupModel
.areAllSelectedInConflictWith( filterItem
) &&
157 // Every selected member of the item's own group is also
158 // in conflict with the other group
159 filterItemGroup
.getSelectedItems().every( function ( otherGroupItem
) {
160 return groupModel
.areAllSelectedInConflictWith( otherGroupItem
);
165 // If we're in conflict, this will return 'false' which
166 // will break the loop. Otherwise, we're not in conflict
167 // and the loop continues
171 // Toggle the item state
172 filterItem
.toggleConflicted( inConflict
);
177 * Get whether the model has any conflict in its items
179 * @return {boolean} There is a conflict
181 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.hasConflict = function () {
182 return this.getItems().some( function ( filterItem
) {
183 return filterItem
.isSelected() && filterItem
.isConflicted();
188 * Get the first item with a current conflict
190 * @return {mw.rcfilters.dm.FilterItem} Conflicted item
192 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFirstConflictedItem = function () {
195 $.each( this.getItems(), function ( index
, filterItem
) {
196 if ( filterItem
.isSelected() && filterItem
.isConflicted() ) {
197 conflictedItem
= filterItem
;
202 return conflictedItem
;
206 * Set filters and preserve a group relationship based on
207 * the definition given by an object
209 * @param {Array} filters Filter group definition
210 * @param {Object} [namespaces] Namespace definition
211 * @param {Object[]} [tags] Tag array definition
213 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.initializeFilters = function ( filters
, namespaces
, tags
) {
214 var filterItem
, filterConflictResult
, groupConflictResult
,
217 namespaceDefinition
= [],
218 groupConflictMap
= {},
219 filterConflictMap
= {},
221 * Expand a conflict definition from group name to
222 * the list of all included filters in that group.
223 * We do this so that the direct relationship in the
224 * models are consistently item->items rather than
225 * mixing item->group with item->item.
227 * @param {Object} obj Conflict definition
228 * @return {Object} Expanded conflict definition
230 expandConflictDefinitions = function ( obj
) {
233 $.each( obj
, function ( key
, conflicts
) {
235 adjustedConflicts
= {};
237 conflicts
.forEach( function ( conflict
) {
240 if ( conflict
.filter
) {
241 filterName
= model
.groups
[ conflict
.group
].getPrefixedName( conflict
.filter
);
242 filter
= model
.getItemByName( filterName
);
245 adjustedConflicts
[ filterName
] = $.extend(
254 // This conflict is for an entire group. Split it up to
255 // represent each filter
257 // Get the relevant group items
258 model
.groups
[ conflict
.group
].getItems().forEach( function ( groupItem
) {
259 // Rebuild the conflict
260 adjustedConflicts
[ groupItem
.getName() ] = $.extend(
264 filter
: groupItem
.getName(),
272 result
[ key
] = adjustedConflicts
;
284 this.views
.default = { name
: 'default', label
: mw
.msg( 'rcfilters-filterlist-title' ) };
285 filters
.forEach( function ( data
) {
289 if ( !model
.groups
[ group
] ) {
290 model
.groups
[ group
] = new mw
.rcfilters
.dm
.FilterGroup( group
, {
292 title
: data
.title
? mw
.msg( data
.title
) : group
,
293 separator
: data
.separator
,
294 fullCoverage
: !!data
.fullCoverage
,
296 body
: data
.whatsThisBody
,
297 header
: data
.whatsThisHeader
,
298 linkText
: data
.whatsThisLinkText
,
299 url
: data
.whatsThisUrl
304 // Filters are given to us with msg-keys, we need
305 // to translate those before we hand them off
306 for ( i
= 0; i
< data
.filters
.length
; i
++ ) {
307 data
.filters
[ i
].label
= data
.filters
[ i
].label
? mw
.msg( data
.filters
[ i
].label
) : data
.filters
[ i
].name
;
308 data
.filters
[ i
].description
= data
.filters
[ i
].description
? mw
.msg( data
.filters
[ i
].description
) : '';
311 model
.groups
[ group
].initializeFilters( data
.filters
, data
.default );
312 items
= items
.concat( model
.groups
[ group
].getItems() );
315 if ( data
.conflicts
) {
317 groupConflictMap
[ group
] = data
.conflicts
;
320 for ( i
= 0; i
< data
.filters
.length
; i
++ ) {
322 if ( data
.filters
[ i
].conflicts
) {
323 filterItem
= model
.groups
[ group
].getItemByParamName( data
.filters
[ i
].name
);
324 filterConflictMap
[ filterItem
.getName() ] = data
.filters
[ i
].conflicts
;
329 namespaces
= namespaces
|| {};
331 mw
.config
.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ) &&
332 !$.isEmptyObject( namespaces
)
335 this.views
.namespaces
= { name
: 'namespaces', label
: mw
.msg( 'namespaces' ), trigger
: ':' };
336 $.each( namespaces
, function ( namespaceID
, label
) {
337 // Build and clean up the definition
338 namespaceDefinition
.push( {
340 label
: label
|| mw
.msg( 'blanknamespace' ),
343 ( namespaceID
< 0 || namespaceID
% 2 === 0 ) ?
346 cssClass
: 'mw-changeslist-ns-' + namespaceID
351 model
.groups
.namespace = new mw
.rcfilters
.dm
.FilterGroup(
352 'namespace', // Parameter name is singular
354 type
: 'string_options',
356 title
: 'namespaces', // Message key
358 labelPrefixKey
: { 'default': 'rcfilters-tag-prefix-namespace', inverted
: 'rcfilters-tag-prefix-namespace-inverted' },
362 // Add namespace items to group
363 model
.groups
.namespace.initializeFilters( namespaceDefinition
);
364 items
= items
.concat( model
.groups
.namespace.getItems() );
369 mw
.config
.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ) &&
373 this.views
.tags
= { name
: 'tags', label
: mw
.msg( 'rcfilters-view-tags' ), trigger
: '#' };
376 model
.groups
.tags
= new mw
.rcfilters
.dm
.FilterGroup(
379 type
: 'string_options',
381 title
: 'rcfilters-view-tags', // Message key
382 labelPrefixKey
: 'rcfilters-tag-prefix-tags',
388 // Add tag items to group
389 model
.groups
.tags
.initializeFilters( tags
);
391 // Add item references to the model, for lookup
392 items
= items
.concat( model
.groups
.tags
.getItems() );
395 // Add item references to the model, for lookup
396 this.addItems( items
);
399 groupConflictResult
= expandConflictDefinitions( groupConflictMap
);
400 filterConflictResult
= expandConflictDefinitions( filterConflictMap
);
402 // Set conflicts for groups
403 $.each( groupConflictResult
, function ( group
, conflicts
) {
404 model
.groups
[ group
].setConflicts( conflicts
);
407 // Set conflicts for items
408 $.each( filterConflictResult
, function ( filterName
, conflicts
) {
409 var filterItem
= model
.getItemByName( filterName
);
410 // set conflicts for items in the group
411 filterItem
.setConflicts( conflicts
);
414 // Create a map between known parameters and their models
415 $.each( this.groups
, function ( group
, groupModel
) {
416 if ( groupModel
.getType() === 'send_unselected_if_any' ) {
417 // Individual filters
418 groupModel
.getItems().forEach( function ( filterItem
) {
419 model
.parameterMap
[ filterItem
.getParamName() ] = filterItem
;
421 } else if ( groupModel
.getType() === 'string_options' ) {
423 model
.parameterMap
[ groupModel
.getName() ] = groupModel
;
427 this.currentView
= 'default';
429 // Finish initialization
430 this.emit( 'initialize' );
434 * Get the names of all available filters
436 * @return {string[]} An array of filter names
438 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFilterNames = function () {
439 return this.getItems().map( function ( item
) { return item
.getName(); } );
443 * Get the object that defines groups by their name.
445 * @return {Object} Filter groups
447 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFilterGroups = function () {
452 * Get the object that defines groups that match a certain view by their name.
454 * @param {string} [view] Requested view. If not given, uses current view
455 * @return {Object} Filter groups matching a display group
457 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFilterGroupsByView = function ( view
) {
460 view
= view
|| this.getCurrentView();
462 $.each( this.groups
, function ( groupName
, groupModel
) {
463 if ( groupModel
.getView() === view
) {
464 result
[ groupName
] = groupModel
;
472 * Get an array of filters matching the given display group.
474 * @param {string} [view] Requested view. If not given, uses current view
475 * @return {mw.rcfilters.dm.FilterItem} Filter items matching the group
477 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFiltersByView = function ( view
) {
481 view
= view
|| this.getCurrentView();
483 groups
= this.getFilterGroupsByView( view
);
485 $.each( groups
, function ( groupName
, groupModel
) {
486 result
= result
.concat( groupModel
.getItems() );
493 * Get the trigger for the requested view.
495 * @param {string} view View name
496 * @return {string} View trigger, if exists
498 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getViewTrigger = function ( view
) {
499 return ( this.views
[ view
] && this.views
[ view
].trigger
) || '';
502 * Get the value of a specific parameter
504 * @param {string} name Parameter name
505 * @return {number|string} Parameter value
507 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getParamValue = function ( name
) {
508 return this.parameters
[ name
];
512 * Get the current selected state of the filters
514 * @return {Object} Filters selected state
516 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getSelectedState = function () {
518 items
= this.getItems(),
521 for ( i
= 0; i
< items
.length
; i
++ ) {
522 result
[ items
[ i
].getName() ] = items
[ i
].isSelected();
529 * Get the current full state of the filters
531 * @return {Object} Filters full state
533 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFullState = function () {
535 items
= this.getItems(),
538 for ( i
= 0; i
< items
.length
; i
++ ) {
539 result
[ items
[ i
].getName() ] = {
540 selected
: items
[ i
].isSelected(),
541 conflicted
: items
[ i
].isConflicted(),
542 included
: items
[ i
].isIncluded()
550 * Get an object representing default parameters state
552 * @return {Object} Default parameter values
554 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getDefaultParams = function () {
557 // Get default filter state
558 $.each( this.groups
, function ( name
, model
) {
559 $.extend( true, result
, model
.getDefaultParams() );
566 * Analyze the groups and their filters and output an object representing
567 * the state of the parameters they represent.
569 * @param {Object} [filterDefinition] An object defining the filter values,
570 * keyed by filter names.
571 * @return {Object} Parameter state object
573 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getParametersFromFilters = function ( filterDefinition
) {
574 var groupItemDefinition
,
576 groupItems
= this.getFilterGroups();
578 if ( filterDefinition
) {
579 groupItemDefinition
= {};
580 // Filter definition is "flat", but in effect
581 // each group needs to tell us its result based
582 // on the values in it. We need to split this list
583 // back into groupings so we can "feed" it to the
584 // loop below, and we need to expand it so it includes
585 // all filters (set to false)
586 this.getItems().forEach( function ( filterItem
) {
587 groupItemDefinition
[ filterItem
.getGroupName() ] = groupItemDefinition
[ filterItem
.getGroupName() ] || {};
588 groupItemDefinition
[ filterItem
.getGroupName() ][ filterItem
.getName() ] = !!filterDefinition
[ filterItem
.getName() ];
592 $.each( groupItems
, function ( group
, model
) {
595 model
.getParamRepresentation(
596 groupItemDefinition
?
597 groupItemDefinition
[ group
] : null
606 * This is the opposite of the #getParametersFromFilters method; this goes over
607 * the given parameters and translates into a selected/unselected value in the filters.
609 * @param {Object} params Parameters query object
610 * @return {Object} Filter state object
612 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFiltersFromParameters = function ( params
) {
617 // Go over the given parameters, break apart to groupings
618 // The resulting object represents the group with its parameter
619 // values. For example:
626 // group2: "param4|param5"
628 $.each( params
, function ( paramName
, paramValue
) {
629 var itemOrGroup
= model
.parameterMap
[ paramName
];
631 if ( itemOrGroup
instanceof mw
.rcfilters
.dm
.FilterItem
) {
632 groupMap
[ itemOrGroup
.getGroupName() ] = groupMap
[ itemOrGroup
.getGroupName() ] || {};
633 groupMap
[ itemOrGroup
.getGroupName() ][ itemOrGroup
.getParamName() ] = paramValue
;
634 } else if ( itemOrGroup
instanceof mw
.rcfilters
.dm
.FilterGroup
) {
635 // This parameter represents a group (values are the filters)
636 // this is equivalent to checking if the group is 'string_options'
637 groupMap
[ itemOrGroup
.getName() ] = groupMap
[ itemOrGroup
.getName() ] || {};
638 groupMap
[ itemOrGroup
.getName() ] = paramValue
;
642 // Go over all groups, so we make sure we get the complete output
643 // even if the parameters don't include a certain group
644 $.each( this.groups
, function ( groupName
, groupModel
) {
645 result
= $.extend( true, {}, result
, groupModel
.getFilterRepresentation( groupMap
[ groupName
] ) );
652 * Get the highlight parameters based on current filter configuration
654 * @return {Object} Object where keys are "<filter name>_color" and values
655 * are the selected highlight colors.
657 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getHighlightParameters = function () {
660 this.getItems().forEach( function ( filterItem
) {
661 result
[ filterItem
.getName() + '_color' ] = filterItem
.getHighlightColor() || null;
663 result
.highlight
= String( Number( this.isHighlightEnabled() ) );
669 * Extract the highlight values from given object. Since highlights are
670 * the same for filter and parameters, it doesn't matter which one is
671 * given; values will be returned with a full list of the highlights
672 * with colors or null values.
674 * @param {Object} representation Object containing representation of
675 * some or all highlight values
676 * @return {Object} Object where keys are "<filter name>_color" and values
677 * are the selected highlight colors. The returned object
678 * contains all available filters either with a color value
681 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.extractHighlightValues = function ( representation
) {
684 this.getItems().forEach( function ( filterItem
) {
685 var highlightName
= filterItem
.getName() + '_color';
686 result
[ highlightName
] = representation
[ highlightName
] || null;
693 * Sanitize value group of a string_option groups type
694 * Remove duplicates and make sure to only use valid
698 * @param {string} groupName Group name
699 * @param {string[]} valueArray Array of values
700 * @return {string[]} Array of valid values
702 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.sanitizeStringOptionGroup = function ( groupName
, valueArray
) {
703 var validNames
= this.getGroupFilters( groupName
).map( function ( filterItem
) {
704 return filterItem
.getParamName();
707 return mw
.rcfilters
.utils
.normalizeParamOptions( valueArray
, validNames
);
711 * Check whether the current filter state is set to all false.
713 * @return {boolean} Current filters are all empty
715 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.areCurrentFiltersEmpty = function () {
716 // Check if there are either any selected items or any items
717 // that have highlight enabled
718 return !this.getItems().some( function ( filterItem
) {
719 return filterItem
.isSelected() || filterItem
.isHighlighted();
724 * Check whether the default values of the filters are all false.
726 * @return {boolean} Default filters are all false
728 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.areDefaultFiltersEmpty = function () {
731 if ( this.defaultFiltersEmpty
!== null ) {
732 // We only need to do this test once,
733 // because defaults are set once per session
734 defaultFilters
= this.getFiltersFromParameters( this.getDefaultParams() );
735 this.defaultFiltersEmpty
= Object
.keys( defaultFilters
).every( function ( filterName
) {
736 return !defaultFilters
[ filterName
];
740 return this.defaultFiltersEmpty
;
744 * Get the item that matches the given name
746 * @param {string} name Filter name
747 * @return {mw.rcfilters.dm.FilterItem} Filter item
749 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getItemByName = function ( name
) {
750 return this.getItems().filter( function ( item
) {
751 return name
=== item
.getName();
756 * Set all filters to false or empty/all
757 * This is equivalent to display all.
759 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.emptyAllFilters = function () {
760 this.getItems().forEach( function ( filterItem
) {
761 this.toggleFilterSelected( filterItem
.getName(), false );
766 * Toggle selected state of one item
768 * @param {string} name Name of the filter item
769 * @param {boolean} [isSelected] Filter selected state
771 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleFilterSelected = function ( name
, isSelected
) {
772 var item
= this.getItemByName( name
);
775 item
.toggleSelected( isSelected
);
780 * Toggle selected state of items by their names
782 * @param {Object} filterDef Filter definitions
784 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleFiltersSelected = function ( filterDef
) {
785 Object
.keys( filterDef
).forEach( function ( name
) {
786 this.toggleFilterSelected( name
, filterDef
[ name
] );
791 * Get a group model from its name
793 * @param {string} groupName Group name
794 * @return {mw.rcfilters.dm.FilterGroup} Group model
796 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getGroup = function ( groupName
) {
797 return this.groups
[ groupName
];
801 * Get all filters within a specified group by its name
803 * @param {string} groupName Group name
804 * @return {mw.rcfilters.dm.FilterItem[]} Filters belonging to this group
806 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getGroupFilters = function ( groupName
) {
807 return ( this.getGroup( groupName
) && this.getGroup( groupName
).getItems() ) || [];
811 * Find items whose labels match the given string
813 * @param {string} query Search string
814 * @param {boolean} [returnFlat] Return a flat array. If false, the result
815 * is an object whose keys are the group names and values are an array of
816 * filters per group. If set to true, returns an array of filters regardless
818 * @return {Object} An object of items to show
819 * arranged by their group names
821 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.findMatches = function ( query
, returnFlat
) {
822 var i
, searchIsEmpty
,
826 view
= this.getViewByTrigger( query
.substr( 0, 1 ) ),
827 items
= this.getFiltersByView( view
);
829 // Normalize so we can search strings regardless of case and view
830 query
= query
.toLowerCase();
831 if ( view
!== 'default' ) {
832 query
= query
.substr( 1 );
835 // Check if the search if actually empty; this can be a problem when
836 // we use prefixes to denote different views
837 searchIsEmpty
= query
.length
=== 0;
839 // item label starting with the query string
840 for ( i
= 0; i
< items
.length
; i
++ ) {
843 items
[ i
].getLabel().toLowerCase().indexOf( query
) === 0 ||
845 // For tags, we want the parameter name to be included in the search
847 items
[ i
].getParamName().toLowerCase().indexOf( query
) > -1
850 result
[ items
[ i
].getGroupName() ] = result
[ items
[ i
].getGroupName() ] || [];
851 result
[ items
[ i
].getGroupName() ].push( items
[ i
] );
852 flatResult
.push( items
[ i
] );
856 if ( $.isEmptyObject( result
) ) {
857 // item containing the query string in their label, description, or group title
858 for ( i
= 0; i
< items
.length
; i
++ ) {
859 groupTitle
= items
[ i
].getGroupModel().getTitle();
862 items
[ i
].getLabel().toLowerCase().indexOf( query
) > -1 ||
863 items
[ i
].getDescription().toLowerCase().indexOf( query
) > -1 ||
864 groupTitle
.toLowerCase().indexOf( query
) > -1 ||
866 // For tags, we want the parameter name to be included in the search
868 items
[ i
].getParamName().toLowerCase().indexOf( query
) > -1
871 result
[ items
[ i
].getGroupName() ] = result
[ items
[ i
].getGroupName() ] || [];
872 result
[ items
[ i
].getGroupName() ].push( items
[ i
] );
873 flatResult
.push( items
[ i
] );
878 return returnFlat
? flatResult
: result
;
882 * Get items that are highlighted
884 * @return {mw.rcfilters.dm.FilterItem[]} Highlighted items
886 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getHighlightedItems = function () {
887 return this.getItems().filter( function ( filterItem
) {
888 return filterItem
.isHighlightSupported() &&
889 filterItem
.getHighlightColor();
894 * Get items that allow highlights even if they're not currently highlighted
896 * @return {mw.rcfilters.dm.FilterItem[]} Items supporting highlights
898 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getItemsSupportingHighlights = function () {
899 return this.getItems().filter( function ( filterItem
) {
900 return filterItem
.isHighlightSupported();
905 * Switch the current view
907 * @param {string} view View name
910 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.switchView = function ( view
) {
911 if ( this.views
[ view
] && this.currentView
!== view
) {
912 this.currentView
= view
;
913 this.emit( 'update' );
918 * Get the current view
920 * @return {string} Current view
922 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getCurrentView = function () {
923 return this.currentView
;
927 * Get the label for the current view
929 * @return {string} Label for the current view
931 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getCurrentViewLabel = function () {
932 return this.views
[ this.getCurrentView() ].label
;
936 * Get an array of all available view names
938 * @return {string} Available view names
940 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getAvailableViews = function () {
941 return Object
.keys( this.views
);
945 * Get the view that fits the given trigger
947 * @param {string} trigger Trigger
948 * @return {string} Name of view
950 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getViewByTrigger = function ( trigger
) {
951 var result
= 'default';
953 $.each( this.views
, function ( name
, data
) {
954 if ( data
.trigger
=== trigger
) {
963 * Toggle the highlight feature on and off.
964 * Propagate the change to filter items.
966 * @param {boolean} enable Highlight should be enabled
967 * @fires highlightChange
969 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleHighlight = function ( enable
) {
970 enable
= enable
=== undefined ? !this.highlightEnabled
: enable
;
972 if ( this.highlightEnabled
!== enable
) {
973 this.highlightEnabled
= enable
;
975 this.getItems().forEach( function ( filterItem
) {
976 filterItem
.toggleHighlight( this.highlightEnabled
);
979 this.emit( 'highlightChange', this.highlightEnabled
);
984 * Check if the highlight feature is enabled
987 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.isHighlightEnabled = function () {
988 return !!this.highlightEnabled
;
992 * Toggle the inverted namespaces property on and off.
993 * Propagate the change to namespace filter items.
995 * @param {boolean} enable Inverted property is enabled
996 * @fires invertChange
998 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleInvertedNamespaces = function ( enable
) {
999 enable
= enable
=== undefined ? !this.invertedNamespaces
: enable
;
1001 if ( this.invertedNamespaces
!== enable
) {
1002 this.invertedNamespaces
= enable
;
1004 this.getFiltersByView( 'namespaces' ).forEach( function ( filterItem
) {
1005 filterItem
.toggleInverted( this.invertedNamespaces
);
1008 this.emit( 'invertChange', this.invertedNamespaces
);
1013 * Check if the namespaces selection is set to be inverted
1016 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.areNamespacesInverted = function () {
1017 return !!this.invertedNamespaces
;
1021 * Set highlight color for a specific filter item
1023 * @param {string} filterName Name of the filter item
1024 * @param {string} color Selected color
1026 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.setHighlightColor = function ( filterName
, color
) {
1027 this.getItemByName( filterName
).setHighlightColor( color
);
1031 * Clear highlight for a specific filter item
1033 * @param {string} filterName Name of the filter item
1035 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.clearHighlightColor = function ( filterName
) {
1036 this.getItemByName( filterName
).clearHighlightColor();
1040 * Clear highlight for all filter items
1042 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.clearAllHighlightColors = function () {
1043 this.getItems().forEach( function ( filterItem
) {
1044 filterItem
.clearHighlightColor();
1047 }( mediaWiki
, jQuery
) );