Expand all

License

Class for storing license information about an image. For available fields, see TemplateParser::$licenseFieldClasses in the CommonsMetadata extension.

Constructor

new License(shortName, [internalName], [longName], [deedUrl], [attributionRequired], [nonFree]) #

Parameters:

Name Type Attributes Description
shortName string

see #shortName
internalName string optional

see #internalName
longName string optional

see #longName
deedUrl string optional

see #deedUrl
attributionRequired boolean optional

see #attributionRequired
nonFree boolean optional

see #nonFree
Source:

Properties

attributionRequired :boolean #

does the author need to be attributed on reuse?

Type:

  • boolean
Source:
does the author need to be attributed on reuse?

deedUrl :string #

URL to the description of the license (e.g. the CC deed)

Type:

  • string
Source:
URL to the description of the license (e.g.

internalName :string #

internal name of the license, used for localization (e.g. cc-by-sa )

Type:

  • string
Source:
internal name of the license, used for localization (e.g.

longName :string #

full name of the license (e.g. Creative Commons etc. etc.)

Type:

  • string
Source:
full name of the license (e.g.

nonFree :boolean #

is this a non-free license?

Type:

  • boolean
Source:
is this a non-free license?

shortName :string #

short (abbreviated) name of the license (e.g. CC-BY-SA-3.0)

Type:

  • string
Source:
short (abbreviated) name of the license (e.g.

Methods

Returns a short HTML representation of the license.

getShortName() → {string} #

Returns the short name of the license:

  • if we have interface messages for this license (basically just CC and PD), use those
  • otherwise use the short name from the license template (might or might not be translated still, depending on how the template is set up)

Returns:

FIXME a model should not depend on an i18n class. We should probably use view models.

Type
string
Source:

Returns the short name of the license:

  • if we have interface messages for this license (basically just CC and PD), use those
  • otherwise use the short name from the license template (might or might not be translated still, depending on how the template is set up)

isCc() → {boolean} #

Check whether this is a Creative Commons license.

Returns:

Type
boolean
Source:
Check whether this is a Creative Commons license.

isFree() → {boolean} #

Check whether this is a free license.

Returns:

Type
boolean
Source:
Check whether this is a free license.

isPd() → {boolean} #

Check whether this is a public domain "license".

Returns:

Type
boolean
Source:
Check whether this is a public domain "license".

needsAttribution() → {boolean} #

Check whether reusers need to attribute the author

Returns:

Type
boolean
Source:
Check whether reusers need to attribute the author