mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 10:35:48 +00:00
d0d0e156b8
- Added missing @inheritdoc so that generated documentation is
not empty.
- Fixed type of mw.Platform#getMessage from (implied) @property
back to @method.
- Removed notes from mw methods. They are prepended instead of
appended, thus overriding the useful single-line summary
of the method with this random note. Description should either
be replaced entirely (e.g. no @inheritdoc) or inherited.
- Rephrased a few description to be consistent with the others
(e.g. "Get .." and "Add .." instead of "Gets .." or "Adds..").
Follows-up cbe35632f1.
Change-Id: Ie55bb9e18f1524b706f0e195300170e4d552bf73
119 lines
2.9 KiB
JavaScript
119 lines
2.9 KiB
JavaScript
/*!
|
|
* VisualEditor Initialization Platform class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Generic Initialization platform.
|
|
*
|
|
* @abstract
|
|
* @mixins ve.EventEmitter
|
|
*
|
|
* @constructor
|
|
*/
|
|
ve.init.Platform = function VeInitPlatform() {
|
|
// Mixin constructors
|
|
ve.EventEmitter.call( this );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.mixinClass( ve.init.Platform, ve.EventEmitter );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get 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' );
|
|
};
|
|
|
|
/**
|
|
* Get 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' );
|
|
};
|
|
|
|
/**
|
|
* Add 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' );
|
|
};
|
|
|
|
/**
|
|
* Get a message from the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {string} key Message key
|
|
* @param {Mixed...} [args] 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' );
|
|
};
|
|
|
|
/**
|
|
* Add multiple parsed messages to the localization system.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {Object} messages Map of message-key/html pairs
|
|
*/
|
|
ve.init.Platform.prototype.addParsedMessages = function () {
|
|
throw new Error( 've.init.Platform.addParsedMessages must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Get 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' );
|
|
};
|
|
|
|
/**
|
|
* Get client platform string from browser.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {string} Client platform string
|
|
*/
|
|
ve.init.Platform.prototype.getSystemPlatform = function () {
|
|
throw new Error( 've.init.Platform.getSystemPlatform must be overridden in subclass' );
|
|
};
|
|
|
|
/**
|
|
* Get the user language and any fallback languages.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {string[]} User language strings
|
|
*/
|
|
ve.init.Platform.prototype.getUserLanguages = function () {
|
|
throw new Error( 've.init.Platform.getUserLanugages must be overridden in subclass' );
|
|
};
|