resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js

   1 /*!
   2  * MediaWiki Widgets - MediaSearchProvider class.
   3  *
   4  * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt
   5  * @license The MIT License (MIT); see LICENSE.txt
   6  */
   7 ( function () {
   8
   9         /**
  10          * @classdesc Media search provider.
  11          *
  12          * @class
  13          * @extends mw.widgets.MediaResourceProvider
  14          *
  15          * @constructor
  16          * @description Create an instance of `mw.widgets.MediaSearchProvider`.
  17          * @param {string} apiurl The API url
  18          * @param {Object} [config] Configuration options
  19          */
  20         mw.widgets.MediaSearchProvider = function MwWidgetsMediaSearchProvider( apiurl, config ) {
  21                 config = config || {};
  22
  23                 config.staticParams = Object.assign( {
  24                         generator: 'search',
  25                         gsrnamespace: mw.config.get( 'wgNamespaceIds' ).file,
  26                         uselang: mw.config.get( 'wgUserLanguage' )
  27                 }, config.staticParams );
  28
  29                 // Parent constructor
  30                 mw.widgets.MediaSearchProvider.super.call( this, apiurl, config );
  31         };
  32
  33         /* Inheritance */
  34         OO.inheritClass( mw.widgets.MediaSearchProvider, mw.widgets.MediaResourceProvider );
  35
  36         /* Methods */
  37
  38         /**
  39          * @inheritdoc
  40          */
  41         mw.widgets.MediaSearchProvider.prototype.getContinueData = function ( howMany ) {
  42                 return {
  43                         gsroffset: this.getOffset(),
  44                         gsrlimit: howMany || this.getDefaultFetchLimit()
  45                 };
  46         };
  47
  48         /**
  49          * @inheritdoc
  50          */
  51         mw.widgets.MediaSearchProvider.prototype.setContinue = function ( continueData ) {
  52                 // Update the offset for next time
  53                 this.setOffset( continueData.gsroffset );
  54         };
  55
  56         /**
  57          * @inheritdoc
  58          */
  59         mw.widgets.MediaSearchProvider.prototype.sort = function ( results ) {
  60                 return results.sort( ( a, b ) => a.index - b.index );
  61         };
  62
  63         /**
  64          * @inheritdoc
  65          */
  66         mw.widgets.MediaSearchProvider.prototype.isValid = function () {
  67                 return this.getUserParams().gsrsearch && mw.widgets.MediaSearchProvider.super.prototype.isValid.call( this );
  68         };
  69 }() );