X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=resources%2Fsrc%2Fmediawiki.rcfilters%2Fdm%2Fmw.rcfilters.dm.FilterGroup.js;h=6acc44dc5b41ca1934e3698f6580a0e8c7fcc09c;hb=a2c8c2969420a0f150c03f76e3a0bf9028fcda43;hp=5cca5d836e8b05d6bc3b6de0921d5215de7cdf10;hpb=be656c67a2dde9924e8558563162616ab3ab88dc;p=lhc%2Fweb%2Fwiklou.git diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js index 5cca5d836e..a62acc5b9e 100644 --- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js +++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js @@ -11,12 +11,17 @@ * @cfg {string} [type='send_unselected_if_any'] Group type * @cfg {string} [view='default'] Name of the display group this group * is a part of. - * @cfg {boolean} [isSticky] This group is using a 'sticky' default; meaning - * that every time a value is changed, it becomes the new default + * @cfg {boolean} [sticky] This group is 'sticky'. It is synchronized + * with a preference, does not participate in Saved Queries, and is + * not shown in the active filters area. * @cfg {string} [title] Group title * @cfg {boolean} [hidden] This group is hidden from the regular menu views + * and the active filters area. * @cfg {boolean} [allowArbitrary] Allows for an arbitrary value to be added to the * group from the URL, even if it wasn't initially set up. + * @cfg {number} [range] An object defining minimum and maximum values for numeric + * groups. { min: x, max: y } + * @cfg {number} [minValue] Minimum value for numeric groups * @cfg {string} [separator='|'] Value separator for 'string_options' groups * @cfg {boolean} [active] Group is active * @cfg {boolean} [fullCoverage] This filters in this group collectively cover all results @@ -29,6 +34,7 @@ * @cfg {string} [whatsThis.body] The body of the whatsThis popup message * @cfg {string} [whatsThis.url] The url for the link in the whatsThis popup message * @cfg {string} [whatsThis.linkMessage] The text for the link in the whatsThis popup message + * @cfg {boolean} [visible=true] The visibility of the group */ mw.rcfilters.dm.FilterGroup = function MwRcfiltersDmFilterGroup( name, config ) { config = config || {}; @@ -40,12 +46,14 @@ this.name = name; this.type = config.type || 'send_unselected_if_any'; this.view = config.view || 'default'; - this.sticky = !!config.isSticky; + this.sticky = !!config.sticky; this.title = config.title || name; this.hidden = !!config.hidden; this.allowArbitrary = !!config.allowArbitrary; + this.numericRange = config.range; this.separator = config.separator || '|'; this.labelPrefixKey = config.labelPrefixKey; + this.visible = config.visible === undefined ? true : !!config.visible; this.currSelected = null; this.active = !!config.active; @@ -97,7 +105,8 @@ description: filter.description || '', labelPrefixKey: model.labelPrefixKey, cssClass: filter.cssClass, - identifiers: filter.identifiers + identifiers: filter.identifiers, + defaultHighlightColor: filter.defaultHighlightColor } ); if ( filter.subset ) { @@ -142,7 +151,9 @@ // Store the default parameter state // For this group type, parameter values are direct // We need to convert from a boolean to a string ('1' and '0') - model.defaultParams[ filter.name ] = String( Number( !!filter.default ) ); + model.defaultParams[ filter.name ] = String( Number( filter.default || 0 ) ); + } else if ( model.getType() === 'any_value' ) { + model.defaultParams[ filter.name ] = filter.default; } } ); @@ -179,6 +190,13 @@ this.defaultParams[ this.getName() ] = defaultParam; } + // add highlights to defaultParams + this.getItems().forEach( function ( filterItem ) { + if ( filterItem.isHighlighted() ) { + this.defaultParams[ filterItem.getName() + '_color' ] = filterItem.getHighlightColor(); + } + }.bind( this ) ); + // Store default filter state based on default params this.defaultFilters = this.getFilterRepresentation( this.getDefaultParams() ); @@ -192,7 +210,7 @@ // Verify that single_option group has at least one item selected if ( this.getType() === 'single_option' && - this.getSelectedItems().length === 0 + this.findSelectedItems().length === 0 ) { defaultParam = groupDefault !== undefined ? groupDefault : this.getItems()[ 0 ].getParamName(); @@ -213,34 +231,45 @@ mw.rcfilters.dm.FilterGroup.prototype.onFilterItemUpdate = function ( item ) { // Update state var changed = false, - active = this.areAnySelected(); - - if ( - item.isSelected() && - this.getType() === 'single_option' && - this.currSelected && - this.currSelected !== item - ) { - this.currSelected.toggleSelected( false ); + active = this.areAnySelected(), + model = this; + + if ( this.getType() === 'single_option' ) { + // This group must have one item selected always + // and must never have more than one item selected at a time + if ( this.findSelectedItems().length === 0 ) { + // Nothing is selected anymore + // Select the default or the first item + this.currSelected = this.getItemByParamName( this.defaultParams[ this.getName() ] ) || + this.getItems()[ 0 ]; + this.currSelected.toggleSelected( true ); + changed = true; + } else if ( this.findSelectedItems().length > 1 ) { + // There is more than one item selected + // This should only happen if the item given + // is the one that is selected, so unselect + // all items that is not it + this.findSelectedItems().forEach( function ( itemModel ) { + // Note that in case the given item is actually + // not selected, this loop will end up unselecting + // all items, which would trigger the case above + // when the last item is unselected anyways + var selected = itemModel.getName() === item.getName() && + item.isSelected(); + + itemModel.toggleSelected( selected ); + if ( selected ) { + model.currSelected = itemModel; + } + } ); + changed = true; + } } - // For 'single_option' groups, check if we just unselected all - // items. This should never be the result. If we did unselect - // all (like resetting all filters to false) then this group - // must choose its default item or the first item in the group - if ( - this.getType() === 'single_option' && - !this.getItems().some( function ( filterItem ) { - return filterItem.isSelected(); - } ) - ) { - // Single option means there must be a single option - // selected, so we have to either select the default - // or select the first option - this.currSelected = this.getItemByParamName( this.defaultParams[ this.getName() ] ) || - this.getItems()[ 0 ]; - this.currSelected.toggleSelected( true ); - changed = true; + if ( this.isSticky() ) { + // If this group is sticky, then change the default according to the + // current selection. + this.defaultParams = this.getParamRepresentation( this.getSelectedState() ); } if ( @@ -248,12 +277,6 @@ this.active !== active || this.currSelected !== item ) { - if ( this.isSticky() ) { - // If this group is sticky, then change the default according to the - // current selection. - this.defaultParams = this.getParamRepresentation( this.getSelectedState() ); - } - this.active = active; this.currSelected = item; @@ -288,6 +311,26 @@ return this.allowArbitrary; }; + /** + * Get group maximum value for numeric groups + * + * @return {number|null} Group max value + */ + mw.rcfilters.dm.FilterGroup.prototype.getMaxValue = function () { + return this.numericRange && this.numericRange.max !== undefined ? + this.numericRange.max : null; + }; + + /** + * Get group minimum value for numeric groups + * + * @return {number|null} Group max value + */ + mw.rcfilters.dm.FilterGroup.prototype.getMinValue = function () { + return this.numericRange && this.numericRange.min !== undefined ? + this.numericRange.min : null; + }; + /** * Get group name * @@ -451,7 +494,7 @@ * @param {mw.rcfilters.dm.FilterItem} [excludeItem] Item to exclude from the list * @return {mw.rcfilters.dm.FilterItem[]} Selected items */ - mw.rcfilters.dm.FilterGroup.prototype.getSelectedItems = function ( excludeItem ) { + mw.rcfilters.dm.FilterGroup.prototype.findSelectedItems = function ( excludeItem ) { var excludeName = ( excludeItem && excludeItem.getName() ) || ''; return this.getItems().filter( function ( item ) { @@ -466,7 +509,7 @@ * @return {boolean} All selected items are in conflict with this item */ mw.rcfilters.dm.FilterGroup.prototype.areAllSelectedInConflictWith = function ( filterItem ) { - var selectedItems = this.getSelectedItems( filterItem ); + var selectedItems = this.findSelectedItems( filterItem ); return selectedItems.length > 0 && ( @@ -486,7 +529,7 @@ * @return {boolean} Any of the selected items are in conflict with this item */ mw.rcfilters.dm.FilterGroup.prototype.areAnySelectedInConflictWith = function ( filterItem ) { - var selectedItems = this.getSelectedItems( filterItem ); + var selectedItems = this.findSelectedItems( filterItem ); return selectedItems.length > 0 && ( // The group as a whole is in conflict with this item @@ -539,7 +582,7 @@ if ( buildFromCurrentState ) { // This means we have not been given a filter representation // so we are building one based on current state - filterRepresentation[ item.getName() ] = item.isSelected(); + filterRepresentation[ item.getName() ] = item.getValue(); } else if ( filterRepresentation[ item.getName() ] === undefined ) { // We are given a filter representation, but we have to make // sure that we fill in the missing filters if there are any @@ -559,7 +602,8 @@ // Build result if ( this.getType() === 'send_unselected_if_any' || - this.getType() === 'boolean' + this.getType() === 'boolean' || + this.getType() === 'any_value' ) { // First, check if any of the items are selected at all. // If none is selected, we're treating it as if they are @@ -576,6 +620,8 @@ // Representation is straight-forward and direct from // the parameter value to the filter state result[ filterParamNames[ name ] ] = String( Number( !!value ) ); + } else if ( model.getType() === 'any_value' ) { + result[ filterParamNames[ name ] ] = value; } } ); } else if ( this.getType() === 'string_options' ) { @@ -626,7 +672,8 @@ paramRepresentation = paramRepresentation || {}; if ( this.getType() === 'send_unselected_if_any' || - this.getType() === 'boolean' + this.getType() === 'boolean' || + this.getType() === 'any_value' ) { // Go over param representation; map and check for selections this.getItems().forEach( function ( filterItem ) { @@ -655,6 +702,8 @@ } else if ( model.getType() === 'boolean' ) { // Straight-forward definition of state result[ filterItem.getName() ] = !!Number( paramRepresentation[ filterItem.getParamName() ] ); + } else if ( model.getType() === 'any_value' ) { + result[ filterItem.getName() ] = paramRepresentation[ filterItem.getParamName() ]; } } ); } else if ( this.getType() === 'string_options' ) { @@ -699,9 +748,9 @@ // If any filters are missing, they will get a falsey value this.getItems().forEach( function ( filterItem ) { if ( result[ filterItem.getName() ] === undefined ) { - result[ filterItem.getName() ] = false; + result[ filterItem.getName() ] = this.getFalsyValue(); } - } ); + }.bind( this ) ); // Make sure that at least one option is selected in // single_option groups, no matter what path was taken @@ -712,17 +761,24 @@ this.getType() === 'single_option' && !oneWasSelected ) { + item = this.getItems()[ 0 ]; if ( defaultParams[ this.getName() ] ) { item = this.getItemByParamName( defaultParams[ this.getName() ] ); - } else { - item = this.getItems()[ 0 ]; } + result[ item.getName() ] = true; } return result; }; + /** + * @return {*} The appropriate falsy value for this group type + */ + mw.rcfilters.dm.FilterGroup.prototype.getFalsyValue = function () { + return this.getType() === 'any_value' ? '' : false; + }; + /** * Get current selected state of all filter items in this group * @@ -732,7 +788,7 @@ var state = {}; this.getItems().forEach( function ( filterItem ) { - state[ filterItem.getName() ] = filterItem.isSelected(); + state[ filterItem.getName() ] = filterItem.getValue(); } ); return state; @@ -782,6 +838,19 @@ return this.type; }; + /** + * Check whether this group is represented by a single parameter + * or whether each item is its own parameter + * + * @return {boolean} This group is a single parameter + */ + mw.rcfilters.dm.FilterGroup.prototype.isPerGroupRequestParameter = function () { + return ( + this.getType() === 'string_options' || + this.getType() === 'single_option' + ); + }; + /** * Get display group * @@ -846,4 +915,69 @@ mw.rcfilters.dm.FilterGroup.prototype.isSticky = function () { return this.sticky; }; + + /** + * Normalize a value given to this group. This is mostly for correcting + * arbitrary values for 'single option' groups, given by the user settings + * or the URL that can go outside the limits that are allowed. + * + * @param {string} value Given value + * @return {string} Corrected value + */ + mw.rcfilters.dm.FilterGroup.prototype.normalizeArbitraryValue = function ( value ) { + if ( + this.getType() === 'single_option' && + this.isAllowArbitrary() + ) { + if ( + this.getMaxValue() !== null && + value > this.getMaxValue() + ) { + // Change the value to the actual max value + return String( this.getMaxValue() ); + } else if ( + this.getMinValue() !== null && + value < this.getMinValue() + ) { + // Change the value to the actual min value + return String( this.getMinValue() ); + } + } + + return value; + }; + + /** + * Toggle the visibility of this group + * + * @param {boolean} [isVisible] Item is visible + */ + mw.rcfilters.dm.FilterGroup.prototype.toggleVisible = function ( isVisible ) { + isVisible = isVisible === undefined ? !this.visible : isVisible; + + if ( this.visible !== isVisible ) { + this.visible = isVisible; + this.emit( 'update' ); + } + }; + + /** + * Check whether the group is visible + * + * @return {boolean} Group is visible + */ + mw.rcfilters.dm.FilterGroup.prototype.isVisible = function () { + return this.visible; + }; + + /** + * Set the visibility of the items under this group by the given items array + * + * @param {mw.rcfilters.dm.ItemModel[]} visibleItems An array of visible items + */ + mw.rcfilters.dm.FilterGroup.prototype.setVisibleItems = function ( visibleItems ) { + this.getItems().forEach( function ( itemModel ) { + itemModel.toggleVisible( visibleItems.indexOf( itemModel ) !== -1 ); + } ); + }; }( mediaWiki ) );