summaryrefslogtreecommitdiff
path: root/resources/mediawiki.language/mediawiki.language.init.js
blob: 30307a37de370b12813c5b867c8795a08ce68da9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/**
 * Base language object with methods for storing and getting
 * language data.
 */
( function ( mw, $ ) {

	var language = {
		/**
		 * @var data {Object} Language related data (keyed by language,
		 * contains instances of mw.Map).
		 * @example Set data
		 * <code>
		 *     // Override, extend or create the language data object of 'nl'
		 *     mw.language.setData( 'nl', 'myKey', 'My value' );
		 *
		 *     // Set multiple values at once
		 *     mw.language.setData( 'nl', { 'foo': 'X', 'bar': 'Y' } );
		 * </code>
		 * @example Get GrammarForms data for language 'nl':
		 * <code>
		 *     var grammarForms = mw.language.getData( 'nl', 'grammarForms' );
		 * </code>
		 */
		data: {},

		/**
		 * Convenience method for retreiving language data by language code and data key,
		 * covering for the potential inexistance of a data object for this langiage.
		 * @param langCode {String}
		 * @param dataKey {String}
		 * @return {mixed} Value stored in the mw.Map (or undefined if there is no map for
		   the specified langCode).
		 */
		getData: function ( langCode, dataKey ) {
			var langData = language.data;
			if ( langData && langData[langCode] instanceof mw.Map ) {
				return langData[langCode].get( dataKey );
			}
			return undefined;
		},

		/**
		 * Convenience method for setting language data by language code and data key.
		 * Creates the data mw.Map if there isn't one for the specified language already.
		 *
		 * @param langCode {String}
		 * @param dataKey {String|Object} Key or object of key/values.
		 * @param value {mixed} Value for dataKey, ignored if dataKey is an object.
		 */
		setData: function ( langCode, dataKey, value ) {
			var langData = language.data;
			if ( !( langData[langCode] instanceof mw.Map ) ) {
				langData[langCode] = new mw.Map();
			}
			langData[langCode].set( dataKey, value );
		}
	};

	mw.language = language;

}( mediaWiki, jQuery ) );