mediawiki-extensions-Multim.../resources/mmv/model/mmv.model.License.js
Gergő Tisza c1ff536c3c Get more license info
Fetch more license information from the imageinfo API
(as needed by the reuse panel), store it in a new model

Change-Id: I331598b55b86d13e23a8bcd58c3ad8fcab749e6f
Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/369
2014-03-20 23:07:02 +00:00

83 lines
2.4 KiB
JavaScript

/*
* This file is part of the MediaWiki extension MediaViewer.
*
* MediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MediaViewer. If not, see <http://www.gnu.org/licenses/>.
*/
( function( mw, $ ) {
var LP;
/**
* Class for storing license information about an image. For available fields, see
* TemplateParser::$licenseFieldClasses in the CommonsMetadata extension.
* @class mw.mmv.model.License
* @param {string} shortName see {@link License#shortName}
* @param {string} [internalName] see {@link License#internalName}
* @param {string} [longName] see {@link License#longName}
* @param {string} [deedUrl] see {@link License#deedUrl}
* @constructor
*/
function License(
shortName,
internalName,
longName,
deedUrl
) {
if ( !shortName ) {
throw 'mw.mmv.model.License: shortName is required';
}
/** @property {string} shortName short (abbreviated) name of the license (e.g. CC-BY-SA-3.0) */
this.shortName = shortName;
/** @property {string} internalName internal name of the license, used for localization (e.g. cc-by-sa ) */
this.internalName = internalName;
/** @property {string} longName full name of the license (e.g. Creative Commons etc. etc.) */
this.longName = longName;
/** @property {string} deedUrl URL to the description of the license (e.g. the CC deed) */
this.deedUrl = deedUrl;
}
LP = License.prototype;
/**
* Returns a short HTML representation of the license.
* @return {string}
*/
LP.getShortLink = function () {
if ( this.deedUrl ) {
return this.jqueryToHtml(
$( '<a>' ).prop( {
href: this.deedUrl,
title: this.longName
} ).text( this.shortName )
);
} else {
return this.shortName;
}
};
/**
* Converts a jQuery object to string.
* @param {jQuery} $jq
* @return {string}
*/
LP.jqueryToHtml = function ( $jq ) {
return $( '<span>' ).append( $jq ).html();
};
mw.mmv.model.License = License;
}( mediaWiki, jQuery ) );