Diese Seite beschreibt ausschließlich globale Funktionen. Funktionen, die an ein Modul gebunden sind (z. B. Methoden von $wsAccount oder $wsExternalData), werden in der jeweiligen Modul-Referenz dokumentiert.

Viele Funktionen können alternativ auch als Modifier (Filter) verwendet werden.

Funktionen werden mit runden Klammern aufgerufen. Parameter werden kommasepariert übergeben. Funktionsnamen sind case-sensitive.

Damit das Ergebnis einer Funktion im Template ausgegeben wird, wird die Ausgabe-Schreibweise verwendet:

Das Ergebnis der Funktion muss nicht zwingend sofort im Template ausgegeben werden, sondern kann auch in einer eigenen Variable gespeichert werden, um es später weiter zu verwenden.

Standardmäßig werden Parameter positionsbasiert übergeben (in der Reihenfolge der Signatur).

Wenn die Reihenfolge der Parameter geändert werden soll, müssen benannte Parameter verwendet werden (Name laut Signatur + =). Entscheidend sind dann die Parameternamen – nicht die Position.

Beispiel

Ein Gutschein soll über die Funktion replace umbenannt werden. Aus GUTSCHEIN_buy10 soll GUTSCHEIN_sale10 werden.

Die Signatur lautet: replace(content, search, replace). Bei positionsbasierter Übergabe ist die Reihenfolge daher:

Sobald Parameter benannt übergeben werden (name="..."), ist die Reihenfolge frei:

= In beiden Fällen ist das Ergebnis

Mehrere Funktionen können auch nacheinander angewendet werden, indem die erste Funktion als Argument der zweiten Funktion verwendet wird.

Beispiel

Die VersandkostenID „versand_kostenfrei“ soll sprechend in „VERSAND KOSTENFREI“ umbenannt und die Schreibweise in Versalien (Großschreibung) geändert werden.

Es werden die Funtkionen upper und replace verwendet:

=

Die Funktion abs gibt den Absolutwert einer Zahl zurück – also den Wert ohne Vorzeichen. Eine negative Zahl wird dadurch positiv, eine positive Zahl bleibt unverändert.

Anwendungsbeispiel
Nützlich, um z. B. Rabattbeträge oder Preisdifferenzen im Shop immer als positive Zahl darzustellen – unabhängig davon, ob der Wert in den Daten ein Minus-Vorzeichen hat.

Signatur
abs(value)

Parameter

• value - Die Zahl, deren Absolutwert ermittelt werden soll.

Verwendbar als Modifier
ja

Beispiel mit negativem Wert

Ausgabe

Beispiel mit positivem Wert

Ausgabe

Die Funktion ceil rundet eine Zahl immer auf die nächste ganze Zahl auf – egal, wie klein der Nachkommaanteil ist. ceil(1.1) ergibt also 2, genauso wie ceil(1.9).

Anwendungsbeispiel
Hilfreich, wenn Werte im Shop immer „zugunsten" einer ganzen Einheit aufgerundet werden sollen – z. B. Stückzahlen, Verpackungseinheiten oder berechnete Mengen.

Signatur
ceil(value)

Parameter

• value – Die Zahl, die aufgerundet werden soll.

Verwendbar als Modifier:
ja

Beispiel mit Dezimalzahl resp. Dezimalbruch

Ausgabe (aufgerundet auf die nächste ganze Zahl)

Beispiel mit ganzer Zahl (Ganzzahl)

Ausgabe (ganze Zahl bleibt unverändert)

Gegenstück
floor

Die Funktion currency formatiert einen numerischen Wert als Preisangabe gemäß den Shop-Einstellungen zur Währung. Dazu gehören insbesondere:

• Dezimaltrennzeichen (z. B. , statt .)

• Anzahl der Nachkommastellen (z. B. 2 bei vielen Währungen)

• kaufmännisches Runden auf die konfigurierte Nachkommastellen-Anzahl

Die Funktion berechnet keine Preise (z.B. Steuern, Rabatte oder Versandkosten), sondern formatiert ausschließlich den übergebenen Wert für die Ausgabe.

Anwendungsbeispiel
Eignet sich für die Ausgabe von Beträgen wie Einzelpreisen, Rabatten, Zwischensummen und Gesamtsummen.

Signatur
currency(price)

Parameter

• price - Die Zahl, die als Preis formatiert werden soll.

Verwendbar als Modifier
ja

Beispiel mit Dezimalzahl resp. Dezimalbruch

Ausgabe (kaufmännisch gerundet auf 2 Nachkommastellen)

Beispiel mit Ganzzahl

Ausgabe

Die Funktion dateFmt bringt ein Datum oder einen Zeitpunkt in ein gewünschtes Anzeigeformat. Der Eingabewert muss im ISO-8601-Format vorliegen (z. B. 2018-03-11T11:20:11.000Z) – dieses Format wird von den meisten Systemen automatisch verwendet.

Anwendungsbeispiel
Damit lassen sich z. B. Bestelldaten, Liefertermine oder Aktionszeiträume im Shop leserlich darstellen (z. B. als „11.03.2018" oder „11:20:11").

Signatur
dateFmt(isoDate, fmt)

Parameter

• isoDate – Datum/Zeit im ISO-8601-Format (z. B. 2018-03-11T11:20:11.000Z)

• fmt – Formatangabe, die festlegt, wie die Ausgabe aussehen soll

  • Die wichtigsten Platzhalter im Überblick

    • %d = Tag (01–31)

    • %m = Monat (01–12)

    • %Y = Jahr (4-stellig)

    • %H = Stunde (00–23)

    • %M = Minute (00–59)

    • %S = Sekunde (00–60)

  • Damit können Sie die folgenden Formate einfach „zusammenbauen“, z. B.:

    • "%d.%m.%Y" → 11.03.2018

    • "%H:%M:%S" → 11:20:11

Verwendbar als Modifier
ja

Beispiel zur Ausgabe des Bestelldatums aus der “Bestellzeit”

Ausgabe

Beispiel zur Ausgabe der Uhrzeit aus der “Bestellzeit”

Ausgabe

Die Funktion dateGreaterThan vergleicht zwei Datumswerte (als Strings) miteinander und liefert true, wenn das erste Datum nach dem zweiten Datum liegt.

Anwendungsbeispiel
Damit lässt sich im Template z. B. prüfen, ob ein Liefertermin in der Zukunft liegt oder ob ein Zeitraum bereits überschritten ist.

Signatur
dateGreaterThan(firstDate, secondDate)

Parameter:

• firstDate – Erstes Datum (zu prüfender Wert)

• secondDate – Zweites Datum (Vergleichswert)

Verwendbar als Modifier
ja

Beispiel eines Datumsvergleichs

Ausgabe

Gegenstück
dateLessThan

Die Funktion dateLessThan vergleicht zwei Datumswerte (als Strings) miteinander und liefert true, wenn das erste Datum vor dem zweiten Datum liegt.

Anwendungsbeispiel
Damit lassen sich im Template z. B. Fristen oder Zeiträume prüfen - etwa ob ein Datum bereits überschritten ist oder ob ein Ereignis noch bevorsteht.

Signatur
dateLessThan(firstDate, secondDate)

Parameter

• firstDate – Erstes Datum (zu prüfender Wert)

• secondDate – Zweites Datum (Vergleichswert)

Verwendbar als Modifier
ja

Beispiel eines Datumsvergleichs

Ausgabe

Gegenstück
dateGreaterThan

Die Funktion floor rundet eine Zahl immer auf die nächste ganze Zahl ab – egal, wie groß der Nachkommaanteil ist. floor(4.9) ergibt also 4, genauso wie floor(4.1).

Anwendungsbeispiel
Hilfreich, wenn Werte im Shop grundsätzlich abgerundet werden sollen – z. B. bei berechneten Mengen oder Zwischenergebnissen, die nur als ganze Zahl weiterverarbeitet werden dürfen.

Signatur
floor(value)

Parameter

• value – Numerischer Wert, der abgerundet werden soll.

Verwendbar als Modifier
ja

Beispiel mit Dezimalzahl resp. Dezimalbruch

Ausgabe

Beispiel mit ganzer Zahl

Ausgabe

Gegenstück
ceil

Die Funktion ifnull prüft, ob ein Wert vorhanden ist oder nicht (null bedeutet: „kein Wert vorhanden"). Ist der Wert null, wird stattdessen ein Ersatzwert ausgegeben. Ist ein Wert vorhanden, wird dieser selbst verwendet.

Anwendungsbeispiel
Eignet sich z.B. für Fallback-Logiken im Shop - etwa um ein Ersatzbild anzuzeigen, wenn kein Produktbild vorhanden ist, oder um fehlende Produktdaten durch Standardwerte zu ersetzen.

Signatur
ifnull(object, value)

Parameter

• object - Der zu prüfende Wert.

• value - Der Alternativwert, der ausgegeben wird, wenn object den Wert null hat.

Verwendbar als Modifier
ja

Beispiel mit null-Wert

Ausgabe

Beispiel mit vorhandenem Wert

Ausgabe (der String “web” ist nicht null, daher wird er selbst ausgegeben.

Beispiel mit Produktbild-Fallback
In der Variable $myProduct werden alle Informationen und Daten zu einem Produkt gespeichert. Wenn kein Produktbild gefunden wird ($myProduct.custom.image.normal ist null), dann wird das Ersatzbild noImageNormal.png angezeigt.

Die Funktion int wandelt einen Wert in eine ganze Zahl (Integer) um. Ist die Umwandlung nicht möglich, wird null zurückgegeben.

Anwendungsbeispiel
Nützlich, um z. B. Mengenangaben oder IDs, die als Text vorliegen (etwa aus URL-Parametern), in eine Zahl umzuwandeln, bevor sie weiterverarbeitet werden.

Signatur
int(value)

Parameter

• value - Der Wert, der in eine Ganzzahl konvertiert werden soll.

Verwendbar als Modifier
ja

Beispiel mit konvertierbarem Wert

Ausgabe

Beispiel mit nicht konvertierbarem Wert

Ausgabe

Die Funktion join fügt alle Einträge einer Auflistung zu einem String zusammen. Optional kann ein Separator (Trennzeichen) angegeben werden, der die Elemente voneinander trennt.

Anwendungsbeispiel
Eignet sich z. B. um Produkteigenschaften, Variantenmerkmale oder Kategorien als zusammenhängenden Text auszugeben – etwa kommasepariert in einer Zeile.

Signatur
join(list[, "separator"])

Parameter

• list - Die Auflistung, deren Einträge zusammengefügt werden sollen.

• separator (optional) - Trennzeichen zwischen den Einträgen. Standard: kein Trennzeichen.

Verwendbar als Modifier
ja

Beispiel ohne Separator

Ausgabe

Beispiel mit Separator

Ausgabe

Gegenstück
split

Die Funktion json gibt ein Datenobjekt in der technischen JSON-Schreibweise aus – einem standardisierten Textformat, das sich leicht maschinell verarbeiten lässt.

Anwendungsbeispiel
Nützlich zum Fehlersuchen (Debugging) im Template oder bei der Weitergabe von Daten an externe Dienste (z. B. Tracking, Analytics).

Signatur
json(object)

Parameter

• object - Das Objekt, das als JSON-String ausgegeben werden soll.

Verwendbar als Modifier
ja

Beispiel mit einer Map

Ausgabe

Beispiel mit einem Modul

Ausgabe

Die Funktion keys gibt alle Bezeichner (Schlüssel) eines Datenobjekts (Map) als Auflistung zurück. Eine Map besteht aus Paaren von Bezeichnern und Werten – z. B. {name: "Topseller", price: 12.99}. Mit keys lassen sich gezielt die Bezeichner auslesen.

Anwendungsbeispiel
Nützlich, um z. B. über alle Einträge eines Datenobjekts zu gehen und sowohl die Bezeichner als auch die zugehörigen Werte im Template anzuzeigen – etwa bei dynamisch aufgebauten Produktdaten oder Konfigurationseinstellungen.

Signatur
keys(object)

Parameter

• object - Das Datenobjekt, dessen Bezeichner (Schlüssel) zurückgegeben werden sollen.

Verwendbar als Modifier
ja

Beispiel

Ausgabe

Gibt das letzte Element einer List zurück.

Signatur: last(list)

Gibt die Länge eines Strings, einer List oder einer Map zurück.

Signatur: len(sequence)

Liefert eine Kopie eines Strings, in der alle Buchstaben in Kleinbuchstaben umgewandelt wurden.

Signatur: lower(content)

Gegenstück: upper

Gibt den höchsten Wert einer List (bestehend aus Zahlen) aus.

Signatur: max(list)

Gegenstück: min

Vereint zwei Maps. Es wird kein neues Objekt angelegt, sondern die vereinten Maps werden im ersten Parameter target gespeichert.

Signatur: merge(target, source)

Die Variable $a enthält nun die Map mit beiden Schlüssel-Wert-Paaren.

Bei Maps mit identischen Schlüsseln wird der Wert des ersten Parameters überschrieben.

Gibt den niedrigsten Wert einer List (bestehend aus Zahlen) aus.

Signatur: min(list)

Gegenstück: max

Formatiert eine Zahl bezüglich Dezimaltrenner und Anzahl der Nachkommastellen gemäß der Konfiguration des Shops.

Signatur: preparedFormat(number, formatName)

amount formatiert hier auf ganze Zahlen.

Geplant. Momentan noch nicht unterstützt.

Liefert eine Liste von ganzen Zahlen. Sie beginnt mit dem ersten Parameter start und endet mit dem Erreichen des zweiten Parameters stop. Standardmäßig erfolgt die schrittweise Erhöhung (increment) um 1. Bei absteigenden Zahlenreihen muss ein negatives increment angegeben werden.