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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/**
* Allows to retrieve a specific or a set of
* messages to be added to mw.messages and returned
* by the Api.
*
* @class mw.Api.plugin.messages
* @since 1.27
*/
( function ( mw, $ ) {
'use strict';
$.extend( mw.Api.prototype, {
/**
* Get a set of messages.
*
* @param {Array} messages Messages to retrieve
* @param {Object} [options] Additional parameters for the API call
* @return {jQuery.Promise}
*/
getMessages: function ( messages, options ) {
options = options || {};
return this.get( $.extend( {
action: 'query',
meta: 'allmessages',
ammessages: messages,
amlang: mw.config.get( 'wgUserLanguage' ),
formatversion: 2
}, options ) ).then( function ( data ) {
var result = {};
data.query.allmessages.forEach( function ( obj ) {
if ( !obj.missing ) {
result[ obj.name ] = obj.content;
}
} );
return result;
} );
},
/**
* Loads a set of messages and add them to mw.messages.
*
* @param {Array} messages Messages to retrieve
* @param {Object} [options] Additional parameters for the API call
* @return {jQuery.Promise}
*/
loadMessages: function ( messages, options ) {
return this.getMessages( messages, options ).then( $.proxy( mw.messages, 'set' ) );
},
/**
* Loads a set of messages and add them to mw.messages. Only messages that are not already known
* are loaded. If all messages are known, the returned promise is resolved immediately.
*
* @param {Array} messages Messages to retrieve
* @param {Object} [options] Additional parameters for the API call
* @return {jQuery.Promise}
*/
loadMessagesIfMissing: function ( messages, options ) {
var missing = messages.filter( function ( msg ) {
return !mw.message( msg ).exists();
} );
if ( missing.length === 0 ) {
return $.Deferred().resolve();
}
return this.getMessages( missing, options ).then( $.proxy( mw.messages, 'set' ) );
}
} );
/**
* @class mw.Api
* @mixins mw.Api.plugin.messages
*/
}( mediaWiki, jQuery ) );
|
