summaryrefslogtreecommitdiff
path: root/resources/mediawiki.api/mediawiki.api.category.js
blob: cc6f704f5528ba48f9d4fc6c13c188fce768f98a (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/**
 * Additional mw.Api methods to assist with API calls related to categories.
 */
( function ( mw, $ ) {

	$.extend( mw.Api.prototype, {
		/**
		 * Determine if a category exists.
		 * @param title {mw.Title}
		 * @param success {Function} callback to pass boolean of category's existence
		 * @param err {Function} optional callback to run if api error
		 * @return ajax call object
		 */
		isCategory: function ( title, success, err ) {
			var params, ok;
			params = {
				prop: 'categoryinfo',
				titles: title.toString()
			};
			ok = function ( data ) {
				var exists = false;
				if ( data.query && data.query.pages ) {
					$.each( data.query.pages, function ( id, page ) {
						if ( page.categoryinfo ) {
							exists = true;
						}
					} );
				}
				success( exists );
			};

			return this.get( params, { ok: ok, err: err } );
		},

		/**
		 * Get a list of categories that match a certain prefix.
		 *   e.g. given "Foo", return "Food", "Foolish people", "Foosball tables" ...
		 * @param prefix {String} prefix to match
		 * @param success {Function} callback to pass matched categories to
		 * @param err {Function} optional callback to run if api error
		 * @return {jqXHR}
		 */
		getCategoriesByPrefix: function ( prefix, success, err ) {
			// Fetch with allpages to only get categories that have a corresponding description page.
			var params, ok;
			params = {
				'list': 'allpages',
				'apprefix': prefix,
				'apnamespace': mw.config.get('wgNamespaceIds').category
			};
			ok = function ( data ) {
				var texts = [];
				if ( data.query && data.query.allpages ) {
					$.each( data.query.allpages, function ( i, category ) {
						texts.push( new mw.Title( category.title ).getNameText() );
					} );
				}
				success( texts );
			};

			return this.get( params, { ok: ok, err: err } );
		},


		/**
		 * Get the categories that a particular page on the wiki belongs to
		 * @param title {mw.Title}
		 * @param success {Function} callback to pass categories to (or false, if title not found)
		 * @param err {Function} optional callback to run if api error
		 * @param async {Boolean} optional asynchronousness (default = true = async)
		 * @return {jqXHR}
		 */
		getCategories: function ( title, success, err, async ) {
			var params, ok;
			params = {
				prop: 'categories',
				titles: title.toString()
			};
			if ( async === undefined ) {
				async = true;
			}
			ok = function ( data ) {
				var ret = false;
				if ( data.query && data.query.pages ) {
					$.each( data.query.pages, function ( id, page ) {
						if ( page.categories ) {
							if ( typeof ret !== 'object' ) {
								ret = [];
							}
							$.each( page.categories, function ( i, cat ) {
								ret.push( new mw.Title( cat.title ) );
							} );
						}
					} );
				}
				success( ret );
			};

			return this.get( params, { ok: ok, err: err, async: async } );
		}

	} );

}( mediaWiki, jQuery ) );