2 * MediaWiki Widgets - CategorySelector class.
4 * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
5 * @license The MIT License (MIT); see LICENSE.txt
9 NS_CATEGORY
= mw
.config
.get( 'wgNamespaceIds' ).category
;
12 * Category selector widget. Displays an OO.ui.CapsuleMultiSelectWidget
13 * and autocompletes with available categories.
15 * var selector = new mw.widgets.CategorySelector( {
17 * mw.widgets.CategorySelector.SearchType.OpenSearch,
18 * mw.widgets.CategorySelector.SearchType.InternalSearch
22 * $( '#content' ).append( selector.$element );
24 * selector.setSearchType( [ mw.widgets.CategorySelector.SearchType.SubCategories ] );
26 * @class mw.widgets.CategorySelector
28 * @extends OO.ui.CapsuleMultiSelectWidget
29 * @mixins OO.ui.mixin.PendingElement
32 * @param {Object} [config] Configuration options
33 * @cfg {mw.Api} [api] Instance of mw.Api (or subclass thereof) to use for queries
34 * @cfg {number} [limit=10] Maximum number of results to load
35 * @cfg {mw.widgets.CategorySelector.SearchType[]} [searchTypes=[mw.widgets.CategorySelector.SearchType.OpenSearch]]
36 * Default search API to use when searching.
38 function CategorySelector( config
) {
39 // Config initialization
42 searchTypes
: [ CategorySelector
.SearchType
.OpenSearch
]
44 this.limit
= config
.limit
;
45 this.searchTypes
= config
.searchTypes
;
46 this.validateSearchTypes();
49 mw
.widgets
.CategorySelector
.parent
.call( this, $.extend( true, {}, config
, {
51 filterFromInput
: false
53 // This allows the user to both select non-existent categories, and prevents the selector from
54 // being wiped from #onMenuItemsChange when we change the available options in the dropdown
59 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$handle
} ) );
61 // Event handler to call the autocomplete methods
62 this.$input
.on( 'change input cut paste', OO
.ui
.debounce( this.updateMenuItems
.bind( this ), 100 ) );
65 this.api
= config
.api
|| new mw
.Api();
70 OO
.inheritClass( CategorySelector
, OO
.ui
.CapsuleMultiSelectWidget
);
71 OO
.mixinClass( CategorySelector
, OO
.ui
.mixin
.PendingElement
);
72 CSP
= CategorySelector
.prototype;
77 * Gets new items based on the input by calling
78 * {@link #getNewMenuItems getNewItems} and updates the menu
79 * after removing duplicates based on the data value.
84 CSP
.updateMenuItems = function () {
85 this.getMenu().clearItems();
86 this.getNewMenuItems( this.$input
.val() ).then( function ( items
) {
87 var existingItems
, filteredItems
,
88 menu
= this.getMenu();
90 // Never show the menu if the input lost focus in the meantime
91 if ( !this.$input
.is( ':focus' ) ) {
95 // Array of strings of the data of OO.ui.MenuOptionsWidgets
96 existingItems
= menu
.getItems().map( function ( item
) {
100 // Remove if items' data already exists
101 filteredItems
= items
.filter( function ( item
) {
102 return existingItems
.indexOf( item
) === -1;
105 // Map to an array of OO.ui.MenuOptionWidgets
106 filteredItems
= filteredItems
.map( function ( item
) {
107 return new OO
.ui
.MenuOptionWidget( {
113 menu
.addItems( filteredItems
).toggle( true );
120 CSP
.clearInput = function () {
121 CategorySelector
.parent
.prototype.clearInput
.call( this );
122 // Abort all pending requests, we won't need their results
127 * Searches for categories based on the input.
131 * @param {string} input The input used to prefix search categories
132 * @return {jQuery.Promise} Resolves with an array of categories
134 CSP
.getNewMenuItems = function ( input
) {
137 deferred
= new $.Deferred();
139 if ( $.trim( input
) === '' ) {
140 deferred
.resolve( [] );
141 return deferred
.promise();
144 // Abort all pending requests, we won't need their results
146 for ( i
= 0; i
< this.searchTypes
.length
; i
++ ) {
147 promises
.push( this.searchCategories( input
, this.searchTypes
[ i
] ) );
152 $.when
.apply( $, promises
).done( function () {
153 var categories
, categoryNames
,
155 dataSets
= Array
.prototype.slice
.apply( arguments
);
157 // Collect values from all results
158 allData
= allData
.concat
.apply( allData
, dataSets
);
161 categories
= allData
.filter( function ( value
, index
, self
) {
162 return self
.indexOf( value
) === index
;
166 categoryNames
= categories
.map( function ( name
) {
167 return mw
.Title
.newFromText( name
, NS_CATEGORY
).getMainText();
170 deferred
.resolve( categoryNames
);
172 } ).always( this.popPending
.bind( this ) );
174 return deferred
.promise();
180 CSP
.createItemWidget = function ( data
) {
181 return new mw
.widgets
.CategoryCapsuleItemWidget( {
182 apiUrl
: this.api
.apiUrl
|| undefined,
183 title
: mw
.Title
.newFromText( data
, NS_CATEGORY
)
188 * Validates the values in `this.searchType`.
193 CSP
.validateSearchTypes = function () {
194 var validSearchTypes
= false,
195 searchTypeEnumCount
= Object
.keys( CategorySelector
.SearchType
).length
;
197 // Check if all values are in the SearchType enum
198 validSearchTypes
= this.searchTypes
.every( function ( searchType
) {
199 return searchType
> -1 && searchType
< searchTypeEnumCount
;
202 if ( validSearchTypes
=== false ) {
203 throw new Error( 'Unknown searchType in searchTypes' );
206 // If the searchTypes has CategorySelector.SearchType.SubCategories
207 // it can be the only search type.
208 if ( this.searchTypes
.indexOf( CategorySelector
.SearchType
.SubCategories
) > -1 &&
209 this.searchTypes
.length
> 1
211 throw new Error( 'Can\'t have additional search types with CategorySelector.SearchType.SubCategories' );
214 // If the searchTypes has CategorySelector.SearchType.ParentCategories
215 // it can be the only search type.
216 if ( this.searchTypes
.indexOf( CategorySelector
.SearchType
.ParentCategories
) > -1 &&
217 this.searchTypes
.length
> 1
219 throw new Error( 'Can\'t have additional search types with CategorySelector.SearchType.ParentCategories' );
226 * Sets and validates the value of `this.searchType`.
228 * @param {mw.widgets.CategorySelector.SearchType[]} searchTypes
230 CSP
.setSearchTypes = function ( searchTypes
) {
231 this.searchTypes
= searchTypes
;
232 this.validateSearchTypes();
236 * Searches categories based on input and searchType.
240 * @param {string} input The input used to prefix search categories
241 * @param {mw.widgets.CategorySelector.SearchType} searchType
242 * @return {jQuery.Promise} Resolves with an array of categories
244 CSP
.searchCategories = function ( input
, searchType
) {
245 var deferred
= new $.Deferred();
247 switch ( searchType
) {
248 case CategorySelector
.SearchType
.OpenSearch
:
250 action
: 'opensearch',
251 namespace: NS_CATEGORY
,
254 } ).done( function ( res
) {
255 var categories
= res
[ 1 ];
256 deferred
.resolve( categories
);
257 } ).fail( deferred
.reject
.bind( deferred
) );
260 case CategorySelector
.SearchType
.InternalSearch
:
264 apnamespace
: NS_CATEGORY
,
268 } ).done( function ( res
) {
269 var categories
= res
.query
.allpages
.map( function ( page
) {
272 deferred
.resolve( categories
);
273 } ).fail( deferred
.reject
.bind( deferred
) );
276 case CategorySelector
.SearchType
.Exists
:
277 if ( input
.indexOf( '|' ) > -1 ) {
278 deferred
.resolve( [] );
285 titles
: 'Category:' + input
286 } ).done( function ( res
) {
290 for ( page
in res
.query
.pages
) {
291 if ( parseInt( page
, 10 ) > -1 ) {
292 categories
.push( res
.query
.pages
[ page
].title
);
296 deferred
.resolve( categories
);
297 } ).fail( deferred
.reject
.bind( deferred
) );
300 case CategorySelector
.SearchType
.SubCategories
:
301 if ( input
.indexOf( '|' ) > -1 ) {
302 deferred
.resolve( [] );
308 list
: 'categorymembers',
311 cmtitle
: 'Category:' + input
312 } ).done( function ( res
) {
313 var categories
= res
.query
.categorymembers
.map( function ( category
) {
314 return category
.title
;
316 deferred
.resolve( categories
);
317 } ).fail( deferred
.reject
.bind( deferred
) );
320 case CategorySelector
.SearchType
.ParentCategories
:
321 if ( input
.indexOf( '|' ) > -1 ) {
322 deferred
.resolve( [] );
330 titles
: 'Category:' + input
331 } ).done( function ( res
) {
335 for ( page
in res
.query
.pages
) {
336 if ( parseInt( page
, 10 ) > -1 ) {
337 if ( $.isArray( res
.query
.pages
[ page
].categories
) ) {
338 categories
.push
.apply( categories
, res
.query
.pages
[ page
].categories
.map( function ( category
) {
339 return category
.title
;
345 deferred
.resolve( categories
);
346 } ).fail( deferred
.reject
.bind( deferred
) );
350 throw new Error( 'Unknown searchType' );
353 return deferred
.promise();
357 * @enum mw.widgets.CategorySelector.SearchType
358 * Types of search available.
360 CategorySelector
.SearchType
= {
361 /** Search using action=opensearch */
364 /** Search using action=query */
367 /** Search for existing categories with the exact title */
370 /** Search only subcategories */
373 /** Search only parent categories */
377 mw
.widgets
.CategorySelector
= CategorySelector
;
378 }( jQuery
, mediaWiki
) );