mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 10:35:48 +00:00
381472ac99
Rewrite VisualEditorMessagesModule: * Replace copy-paste dump of user-css module with stuff for VisualEditor (class commend and module::$origin). * Remove duplication between getMessages and getScript. * Actually implement getModifiedTime so that the comment in getMessages() about cache invalidation is actually true Fixes bug 42670: ext.visualEditor.specialMessages cache broken ve.init: * Implement addParsedMessages and getParsedMessage so that we don't mix up plain messages with raw html messages (minoredit was previously overloaded in mw.msg storage with a parsed html message and retrieved though ve.msg, which is documented as retuning plain text, not raw html). This is now separated into a different method. * Improved documentation of the other msg methods to emphasise their differences * Removed redundant code in attachSaveDialog() that was (partially) already done in setupSaveDialog() and moved the remaining bits into it as well. Checked all callers of these and they are both only called from ViewPageTarget.prototype.onLoad * Also implement them in the standalone platform implementation, with the html escaper based on mw.html.escape * Update init.platform.getMessage to use undefined instead of discouraged 'if-in' statement. * Add test suite. demos/test: * Re-run makeStaticLoader.php on test to add ve.init.Platform.test * Re-run makeStaticLoader.php on demos and update i18n caller to use ve.init.platform.addParsedMessages (also moved out of the auto-generated block for easier updating) Change-Id: I7f26b47e9467e850c08b9c217c4f1098590de109
106 lines
2.5 KiB
JavaScript
106 lines
2.5 KiB
JavaScript
/**
|
|
* VisualEditor initialization Target class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Generic platform.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @constructor
|
|
* @extends {ve.EventEmitter}
|
|
*/
|
|
ve.init.Platform = function VeInitPlatform() {
|
|
// Parent constructor
|
|
ve.EventEmitter.call( this );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.init.Platform, ve.EventEmitter );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Gets a regular expression that matches allowed external link URLs.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {RegExp} Regular expression object
|
|
*/
|
|
ve.init.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
|
|
throw new Error( 've.init.Platform.getExternalLinkUrlProtocolsRegExp must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Gets a remotely accessible URL to the modules directory.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {String} Remote modules URL
|
|
*/
|
|
ve.init.Platform.prototype.getModulesUrl = function () {
|
|
throw new Error( 've.init.Platform.getModulesUrl must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Whether to use change markers
|
|
*
|
|
* @method
|
|
* @returns {Boolean}
|
|
*/
|
|
ve.init.Platform.prototype.useChangeMarkers = function () {
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Adds multiple messages to the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {Object} messages Containing plain message values.
|
|
*/
|
|
ve.init.Platform.prototype.addMessages = function () {
|
|
throw new Error( 've.init.Platform.addMessages must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Gets a message from the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {String} key Message key
|
|
* @param {Mixed} [...] List of arguments which will be injected at $1, $2, etc. in the messaage
|
|
* @returns {String} Localized message
|
|
*/
|
|
ve.init.Platform.prototype.getMessage = function () {
|
|
throw new Error( 've.init.Platform.getMessage must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Adds multiple parsed messages to the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {Object} messages Containing parsed html strings
|
|
*/
|
|
ve.init.Platform.prototype.addParsedMessages = function () {
|
|
throw new Error( 've.init.Platform.addParsedMessages must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Gets a parsed message as HTML string.
|
|
* Does not support $# replacements.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {String} key Message key
|
|
* @returns {String} Parsed localized message as HTML string.
|
|
*/
|
|
ve.init.Platform.prototype.getParsedMessage = function () {
|
|
throw new Error( 've.init.Platform.getParsedMessage must be overridden in subclass' );
|
|
};
|