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

   1 /*!
   2  * MediaWiki Widgets - MediaUserUploadsProvider 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 User uploads provider.
  11          *
  12          * @class
  13          * @extends mw.widgets.MediaResourceProvider
  14          *
  15          * @constructor
  16          * @description Create an instance of `mw.widgets.MediaUserUploadsProvider`.
  17          * @param {string} apiurl The API url
  18          * @param {Object} [config] Configuration options
  19          */
  20         mw.widgets.MediaUserUploadsProvider = function MwWidgetsMediaUserUploadsProvider( apiurl, config ) {
  21                 config = config || {};
  22
  23                 config.staticParams = Object.assign( {
  24                         generator: 'allimages',
  25                         gaisort: 'timestamp',
  26                         gaidir: 'descending'
  27                 }, config.staticParams );
  28
  29                 // Parent constructor
  30                 mw.widgets.MediaUserUploadsProvider.super.call( this, apiurl, config );
  31         };
  32
  33         /* Inheritance */
  34         OO.inheritClass( mw.widgets.MediaUserUploadsProvider, mw.widgets.MediaResourceProvider );
  35
  36         /* Methods */
  37
  38         /**
  39          * @inheritdoc
  40          */
  41         mw.widgets.MediaUserUploadsProvider.prototype.getContinueData = function ( howMany ) {
  42                 return {
  43                         gaicontinue: this.getOffset() || undefined,
  44                         gailimit: howMany || this.getDefaultFetchLimit()
  45                 };
  46         };
  47
  48         /**
  49          * @inheritdoc
  50          */
  51         mw.widgets.MediaUserUploadsProvider.prototype.setContinue = function ( continueData ) {
  52                 // Update the offset for next time
  53                 this.setOffset( continueData.gaicontinue );
  54         };
  55
  56         /**
  57          * @inheritdoc
  58          */
  59         mw.widgets.MediaUserUploadsProvider.prototype.sort = function ( results ) {
  60                 return results.sort(
  61                         // timestamps are strings
  62                         ( a, b ) => a.timestamp < b.timestamp ? 1 : ( a.timestamp === b.timestamp ? 0 : -1 )
  63                 );
  64         };
  65
  66         /**
  67          * @inheritdoc
  68          */
  69         mw.widgets.MediaUserUploadsProvider.prototype.isValid = function () {
  70                 return this.getUserParams().gaiuser && mw.widgets.MediaUserUploadsProvider.super.prototype.isValid.call( this );
  71         };
  72 }() );