Modul:Common/Doku

Diese Seite ist die Dokumentations-Unterseite der Modul:Common/Doku.

Dieses Modul wurde bis jetzt noch nicht dokumentiert. Bitte erstelle eine die Dokumentation hier: Modul:Common/Doku/Doku

Modulabhängigkeiten

Dieses Modul benötigt keine anderen Module.

Modulinfo

Das Modul Common stellt Funktionen bereit, welche allgemein in anderen Modulen weiterverwendet werden.

Öffentliche Methoden

Das Modul stellt folgende öffentliche Methoden bereit:

• extractDataFromPrefix
  • Extrahiert alle Argumente, die mit 'argPrefix' beginnen, aus übergebenen Vorlageparametern
    • keyPrefix string: Präfix der Vorlageparametern.
      • Beispiel: |vorlage_param_1=foo, |vorlage_param_2=bar PREFIX = vorlage_param_
    • args tabelle: Argumente
    • mode string: Betriebsmodus
      • Voreinstellung %w = Zeichenketten oder ganze Zahlen
      • %a = Zeichenketten
      • %d = Ziffern
      • Siehe https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns

• setDisplayTitle
  • Setzt den Abzeigetitel der aktuellen Seite
    • framm tabelle: Der zu bearbeitende Frame
    • title string: Seitentitel
    • flag string: Entweder 'noerror' oder 'noreplace'

• removeTypeSuffix
  • Entfernt (...) Suffixe aus einer Zeichenkette
    • Beispiel:
      • Eingabe: Orion (Raumschiff)
      • Aufruf: common.removeTypeSuffix( 'Orion (Raumschiff)', 'Raumschiff' )
      • Ausgabe: Orion

• checkSmwResult
  • Prüft, ob das Setzen von SMW-Daten erfolgreich war

• checkApiResponse
  • Prüft, ob die Api-Anfrage erfolgreich war und ob die Antwort gültig ist

• toNumber
  • Konvertiert eine Eingabe zu einer Zahl

• formatNum
  • Formatiert eine Zahl entsprechend der Sprache des Inhalts

• slice
  • https://github.com/mirven/underscore.lua/blob/master/lib/underscore.lua

• getImage
  • Findet das erste vorhandene Bild für die aktuelle Seite oder angegebene Namen

• booleanToText
  • Ausgabe einer Zeichenkette basierend auf dem wahrheitsgemäßen Eingangswert

• spairs
  • Sortiertes pairs

• titleparts.get
  • Funktionalität aus https://github.com/wikimedia/mediawiki-extensions-ParserFunctions/blob/master/includes/ParserFunctions.php

• mapTranslation
  • Mapt { de_DE: '...', en_EN: '...' } zu einem Format was Semantic Media Wiki versteht

• getLocaleForPage
  • Gibt den Sprachcode der aktuellen Seite zurück

Tests

✔ Alle Tests bestanden.

	Name	Expected	Actual
✔	testBooleanToTextFalseish
✔	testBooleanToTextFalseishCustomText
✔	testBooleanToTextTrueish
✔	testExtractPrefixNumerical
✔	testExtractPrefixNumericalEmpty
✔	testFormatNum
✔	testFormatNumberString
✔	testFormatNumberStringFail
✔	testRemoveTypeSuffix
✔	testRemoveTypeSuffixNoMatch
✔	testToNumberNum
✔	testToNumberString
✔	testToNumberStringFail