mediawiki-extensions-Revisi.../modules/ext.RevisionSlider.Settings.js
Thiemo Kreuz 7f38c9c579 Improve discoverability of JS code with @class tags
In my PHPStorm IDE, this makes it possible to follow all methods and
properties in these classes, even these that are later defined.
Otherwise only the empty stub of each class is found.

This might be different in other IDEs.

Basically: PHPStorm does not understand the meaning of the $.extend()
syntax from jQuery without these hints.

Change-Id: I4aa76db183122f6669dc72561441f46f0056d793
2020-01-24 17:21:23 +01:00

112 lines
2.4 KiB
JavaScript

( function () {
/**
* @constructor
*/
var Settings = function () {
this.hideHelpDialogue = this.loadBoolean( 'hide-help-dialogue' );
this.autoExpand = this.loadBoolean( 'autoexpand' );
};
/**
* @class mw.libs.revisionSlider.Settings
*/
$.extend( Settings.prototype, {
/**
* @type {boolean}
*/
hideHelpDialogue: null,
/**
* @type {boolean}
*/
autoExpand: null,
/**
* @return {boolean}
*/
shouldHideHelpDialogue: function () {
return this.hideHelpDialogue;
},
/**
* @return {boolean}
*/
shouldAutoExpand: function () {
return this.autoExpand;
},
/**
* @param {boolean} newSetting
*/
setHideHelpDialogue: function ( newSetting ) {
if ( newSetting !== this.hideHelpDialogue ) {
this.saveBoolean( 'hide-help-dialogue', newSetting );
this.hideHelpDialogue = newSetting;
}
},
/**
* @param {boolean} newSetting
*/
setAutoExpand: function ( newSetting ) {
if ( newSetting !== this.autoExpand ) {
this.saveBoolean( 'autoexpand', newSetting );
this.autoExpand = newSetting;
}
},
/**
* @param {string} name
* @param {string} defaultValue
* @return {string|boolean}
*/
loadSetting: function ( name, defaultValue ) {
var setting;
if ( !mw.user.isAnon() ) {
setting = mw.user.options.get( 'userjs-revslider-' + name );
} else {
setting = mw.storage.get( 'mw-revslider-' + name );
if ( !setting ) {
setting = mw.cookie.get( '-revslider-' + name );
}
}
return setting !== null && setting !== false ? setting : defaultValue;
},
/**
* @param {string} name
* @param {boolean} [defaultValue]
* @return {boolean}
*/
loadBoolean: function ( name, defaultValue ) {
return this.loadSetting( name, defaultValue ? '1' : '0' ) === '1';
},
/**
* @param {string} name
* @param {string} value
*/
saveSetting: function ( name, value ) {
if ( !mw.user.isAnon() ) {
( new mw.Api() ).saveOption( 'userjs-revslider-' + name, value );
} else {
if ( !mw.storage.set( 'mw-revslider-' + name, value ) ) {
mw.cookie.set( '-revslider-' + name, value ); // use cookie when localStorage is not available
}
}
},
/**
* @param {string} name
* @param {boolean} value
*/
saveBoolean: function ( name, value ) {
this.saveSetting( name, value ? '1' : '0' );
}
} );
mw.libs.revisionSlider = mw.libs.revisionSlider || {};
mw.libs.revisionSlider.Settings = Settings;
}() );