mediawiki-extensions-Visual.../modules/ve/init/ve.init.Platform.js
Rob Moen f7b6b1e99c Add abstract method for getMediaSources.
Change-Id: I8c51d91a1f8ad1a8c688a6dd3de8ac53d4f8d3f9
2013-09-05 16:39:13 -07:00

130 lines
3.2 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' );
};
/**
* Get a list of URL entry points where media can be found.
*
* @method
* @abstract
* @returns {string[]} API URLs
*/
ve.init.Platform.prototype.getMediaSources = function () {
throw new Error( 've.init.Platform.getMediaSources must be overridden in subclass' );
};