mediawiki-extensions-Visual.../modules/ve-mw/init/ve.init.mw.Platform.js
Timo Tijhof d0d0e156b8 doc: Restore and clean up documentation for Platform subclasses
- 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
2013-08-26 12:47:28 -07:00

107 lines
2.5 KiB
JavaScript

/*!
* VisualEditor MediaWiki Initialization Platform class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/*global mw */
/**
* Initialization MediaWiki platform.
*
* @class
* @extends ve.init.Platform
*
* @constructor
*/
ve.init.mw.Platform = function VeInitMwPlatform() {
// Parent constructor
ve.init.Platform.call( this );
// Properties
this.externalLinkUrlProtocolsRegExp = new RegExp( '^' + mw.config.get( 'wgUrlProtocols' ) );
this.modulesUrl = mw.config.get( 'wgExtensionAssetsPath' ) + '/VisualEditor/modules';
this.parsedMessages = {};
this.mediaSources = [
{ 'url': mw.util.wikiScript( 'api' ) },
{ 'url': '//commons.wikimedia.org/w/api.php' }
];
};
/* Inheritance */
ve.inheritClass( ve.init.mw.Platform, ve.init.Platform );
/* Methods */
/** @inheritdoc */
ve.init.mw.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
return this.externalLinkUrlProtocolsRegExp;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.getModulesUrl = function () {
return this.modulesUrl;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.addMessages = function ( messages ) {
return mw.messages.set( messages );
};
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getMessage = ve.bind( mw.msg, mw );
/** @inheritdoc */
ve.init.mw.Platform.prototype.addParsedMessages = function ( messages ) {
for ( var key in messages ) {
this.parsedMessages[key] = messages[key];
}
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.getParsedMessage = function ( key ) {
if ( key in this.parsedMessages ) {
// Prefer parsed results from VisualEditorMessagesModule.php if available.
return this.parsedMessages[key];
}
// Fallback to regular messages, with mw.message html escaping applied.
return mw.message( key ).escaped();
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.getSystemPlatform = function () {
return $.client.profile().platform;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.getUserLanguages = function () {
var lang = mw.config.get( 'wgUserLanguage' ),
langParts = lang.split( '-' ),
langs = [ lang ];
if ( langParts.length > 0 ) {
langs.push( langParts[0] );
}
return langs;
};
/**
* Get a list of URLs to MediaWiki API entry points where media can be found.
*
* @method
* @returns {string[]} API URLs
*/
ve.init.mw.Platform.prototype.getMediaSources = function () {
return this.mediaSources;
};
/* Initialization */
ve.init.platform = new ve.init.mw.Platform();