$wsConfig - Konfiguration - WEBSALE Dokumentation

Mit dem $wsConfig-Modul lesen Sie die Konfigurationsdaten des Shops im Frontend, beispielsweise die verfügbaren Länder, die Währung, die Zahlungs- und Versandarten sowie die konfigurierten Anreden und Titel. Auf dieser Seite geht es um das Lesen der Konfiguration. Die Konfiguration selbst wird im Admin-Interface bzw. per Code gepflegt, nicht über dieses Modul.

Grundkonzept

$wsConfig ist ein reines Lese-Modul. Es spiegelt die im Shop hinterlegte Konfiguration zum Zeitpunkt des Seitenaufbaus wider. Die Werte ändern sich nur, wenn die Konfiguration geändert wird und nicht durch eine Aktion des Kunden. Die Variablen lassen sich wie folgt gruppieren:

Listen für Formulare – countries, salutation, title, listElements: füllen z. B. Auswahlfelder in Adress- und Anmeldeformularen.
Checkout-Optionen – payments, shippingMethods: die verfügbaren Zahlungs- und Versandarten.
Anzeige – currency: Währungssymbol und -codes.
Verhalten und Sicherheit – passwordChecks, passwordReset, directOrder, redirects, emails.
Werbemittelkennzeichen – inserts: Einstellungen der Werbemittelkennzeichnung (aktiv, Trennzeichen, Position, Standardcode).

Währung formatieren

Der currency-Filter (| currency) gibt einen Betrag bereits mit Währungssymbol aus (z. B. 1.500,00 €). Verwenden Sie currency.symbol deshalb nicht zusätzlich zu | currency – sonst erscheint das Symbol doppelt. currency.symbol brauchen Sie nur, wenn Sie einen Wert selbst formatieren oder das Symbol einzeln anzeigen.

Modulübersicht

Beispiel / Ausschnitt über $wsConfig

{{= $wsConfig | json }}

JSON-Ausgabe

{
  "countries": [ { "isoAlpha2": "...", "isoAlpha3": "...", "isoNum": "...", "name": "..." } ],
  "currency": { "symbol": "...", "isoCode": "...", "isoNum": "..." },
  "directOrder": { "initialNumber": 0, "maximalNumber": 0, "refreshedNumber": 0, "itemNumberFields": [...] },
  "emails": [...],
  "inserts": { "enabled": false, "separator": "...", "position": "...", "defaultInsertCode": "..." },
  "listElements": { "bill": { }, "delivery": { } },
  "passwordChecks": { "maxLength": { "len": 0 }, "minLength": { "len": 0 } },
  "passwordReset": { "checkLoginID": false, "checkOldPassword": false },
  "payments": [ { "id": "...", "name": "...", "description": "...", "image": "..." } ],
  "redirects": [...],
  "salutation": { "codeList": [ { "code": "...", "text": "..." } ] },
  "shippingMethods": [ { "id": "...", "name": "...", "description": "...", "image": "...", "link": "...", "type": "...", "group": "..." } ],
  "shippingMethodGroups": [ { "id": "...", "name": "...", "description": "...", "image": "...", "link": "..." } ],
  "title": { "codeList": [ { "code": "...", "text": "..." } ] }
}

Variablen in der Übersicht

Variable	Typ	Beschreibung
`countries`	array	Konfigurierte Länder (Struktur siehe unten).
`currency`	map	Währungsdaten (Symbol, Codes).
`salutation`	map	Konfigurierte Anreden (unter `codeList`).
`title`	map	Konfigurierte Titel (unter `codeList`).
`payments`	array	Konfigurierte Zahlungsarten (Struktur siehe unten).
`shippingMethods`	array	Konfigurierte Versandarten (Struktur siehe unten).
`shippingMethodGroups`	array	Gruppen von Versandarten (Struktur siehe unten).
`listElements`	map	Adresstyp-Optionen für Formulare (`bill`, `delivery`).
`passwordChecks`	map	Passwort-Längenregeln.
`passwordReset`	map	Einstellungen zum Passwort-Reset.
`directOrder`	map	Einstellungen der Direktbestellung.
`emails`	array	E-Mail-Konfigurationen.
`redirects`	array	Weiterleitungs-Konfigurationen.
`inserts`	map	Einstellungen der Werbemittelkennzeichnung (aktiv, Trennzeichen, Position, Standardcode).
`b2bSubAccounts`	map	B2B-Unterkonten-Einstellungen (`subAccountsEnabled`, `adminCanEditMemberAddresses`).

Templates

Die Konfigurationsdaten können auf jeder Seite verwendet werden. Typische Einsatzgebiete: Formulare (Länder-, Anredeauswahl), Checkout (Zahlungs- und Versandarten) und Preisanzeige (Währung).

Variablen

$wsConfig.countries

Gibt die konfigurierten Länder aus. Nutzen Sie die Liste, um beispielsweise ein Länder-Auswahlfeld in einem Adressformular zu füllen.

{{ foreach $country in $wsConfig.countries }}
  {{= $country.name }} ({{= $country.isoAlpha2 }})
{{ /foreach }}

Eigenschaften eines Landes

Eigenschaft	Typ	Beschreibung
`nodeId`	string	ID des Konfigurationsknotens dieses Landes, als zweiter Parameter für `$wsOptions.get(name, nodeId)`.
`name`	string	Name des Landes.
`isoAlpha2`	string	ISO-2-Ländercode (z. B. `"DE"`, `"AT"`).
`isoAlpha3`	string	ISO-3-Ländercode (z. B. `"DEU"`, `"AUT"`).
`isoNum`	string	ISO-Zifferncode (z. B. `"276"`, `"040"`).

$wsConfig.currency

Gibt die Währungsdaten aus. Für die Anzeige eines Betrags verwenden Sie in der Regel den currency-Filter (siehe Währung formatieren).

Eigenschaften von `$wsConfig.currency`

Eigenschaft	Typ	Beschreibung
`nodeId`	string	ID des Konfigurationsknotens der Währungs-Konfiguration, als zweiter Parameter für `$wsOptions.get(name, nodeId)`.
`symbol`	string	Währungssymbol (z. B. `€`).
`isoCode`	string	ISO-Währungscode (z. B. `"EUR"`).
`isoNum`	string	ISO-Zifferncode der Währung (z. B. `"978"`).

Währung: {{= $wsConfig.currency.isoCode }} ({{= $wsConfig.currency.symbol }})

$wsConfig.salutation

Gibt die konfigurierten Anreden aus. Die eigentliche Liste liegt unter salutation.codeList. Nutzen Sie sie beispielsweise, um ein Anrede-Auswahlfeld zu füllen.

{{ foreach $salutation in $wsConfig.salutation.codeList }}
  {{= $salutation.text }}
{{ /foreach }}

Eigenschaften eines Eintrags in `salutation.codeList`

Eigenschaft	Typ	Beschreibung
`code`	string	Anrede-Code (z. B. `"1"`, `"2"`).
`text`	string	Anzeigetext (z. B. `"Herr"`, `"Frau"`, `"Familie"`, `"Firma"`).

$wsConfig.title

Gibt die konfigurierten Titel aus. Die Liste liegt unter title.codeList. Aufbau analog zu salutation.

{{ foreach $title in $wsConfig.title.codeList }}
  {{= $title.text }}
{{ /foreach }}

Eigenschaften eines Eintrags in `title.codeList`

Eigenschaft	Typ	Beschreibung
`code`	string	Titel-Code (z. B. `"1"`).
`text`	string	Anzeigetext (z. B. `"Dr."`, `"Prof."`; kann leer sein).

$wsConfig.payments

Gibt die konfigurierten Zahlungsarten aus. Nutzen Sie sie, um die verfügbaren Zahlungsarten anzuzeigen.

{{ foreach $payment in $wsConfig.payments }}
  {{= $payment.name }}: {{= $payment.description }}
{{ /foreach }}

Eigenschaften einer Zahlungsart

Eigenschaft	Typ	Beschreibung
`id`	string	ID der Zahlungsart (z. B. `"paypalCheckout"`, `"stripe"`).
`nodeId`	string	ID des Konfigurationsknotens dieser Zahlungsart, als zweiter Parameter für `$wsOptions.get(name, nodeId)`. Nicht zu verwechseln mit `id`.
`name`	string	Name der Zahlungsart.
`description`	string	Beschreibung der Zahlungsart.
`longDescription`	string	Längere Beschreibung der Zahlungsart (lange Variante von `description`), gepflegt unter `payment.payment`.
`image`	string	Bild-URL der Zahlungsart.
`discount`	float	Rabatt der Zahlungsart.
`provider`	string	Anbieter der Zahlungsart.
`type`	string	Typ der Zahlungsart.
`labels`	array	Labels der Zahlungsart.
`displayInfo`	array	Zusätzliche Anzeigeinformationen (siehe Hinweis).

displayInfo ist nur befüllt, wenn für die Zahlungsart der Parameter displayPaymentTypes konfiguriert wurde. Jeder Eintrag enthält name, description und image.

{{ foreach $payment in $wsConfig.payments }}
  {{ foreach $info in $payment.displayInfo }}
    {{= $info.name }} – {{= $info.description }}
  {{ /foreach }}
{{ /foreach }}

$wsConfig.shippingMethods

Gibt die konfigurierten Versandarten aus.

{{ foreach $shipping in $wsConfig.shippingMethods }}
  {{= $shipping.name }} ({{= $shipping.type }})
{{ /foreach }}

Eigenschaften einer Versandart

Eigenschaft	Typ	Beschreibung
`id`	string	ID der Versandart (z. B. `"dhl"`).
`nodeId`	string	ID des Konfigurationsknotens dieser Versandart, als zweiter Parameter für `$wsOptions.get(name, nodeId)`.
`name`	string	Name der Versandart.
`description`	string	Beschreibung der Versandart.
`image`	string	Bild-URL der Versandart.
`link`	string	Link zur Versandart (z. B. Tracking-Seite).
`type`	string	Typ der Versandart (z. B. `"standard"`).
`group`	string	Zugeordnete Versandart-Gruppe (kann `null` sein).

Die Versandkosten sind nicht Teil der Konfiguration. Sie hängen vom Warenkorb ab und werden über $wsCheckout.getShippingCost(shippingMethodId) ermittelt.

$wsConfig.shippingMethodGroups

Gibt die konfigurierten Versandarten-Gruppen aus. Über eine Gruppe lassen sich mehrere Versandarten zusammenfassen (z. B. nach Anbieter oder Lieferart). Welche Gruppe einer Versandart zugeordnet ist, steht im Feld group der jeweiligen Versandart (siehe Eigenschaften einer Versandart).

{{ foreach $group in $wsConfig.shippingMethodGroups }}
  {{= $group.name }}: {{= $group.description }}
{{ /foreach }}

Eigenschaften einer Gruppe

Eigenschaft	Typ	Beschreibung
`id`	string	ID der Gruppen-Konfiguration.
`nodeId`	string	ID des Konfigurationsknotens dieser Gruppe, als zweiter Parameter für `$wsOptions.get(name, nodeId)`.
`name`	string	Name der Gruppe.
`description`	string	Beschreibung der Gruppe.
`image`	string	Bild-URL (Link) der Gruppe.
`link`	string	Link der Gruppe.

$wsConfig.listElements

Gibt die Adresstyp-Optionen für Formulare aus, getrennt nach bill (Rechnungsadresse) und delivery (Lieferadresse), beispielsweise Privat / Firma.

{{ foreach $list in $wsConfig.listElements.bill }}
  <select name="addressType">
    {{ foreach $option in $list.values }}
      <option value="{{= $option.value }}"{{ if $option.value == $list.defaultValue }} selected{{ /if }}>
        {{= $option.name }}
      </option>
    {{ /foreach }}
  </select>
{{ /foreach }}

Eigenschaften eines Eintrags in `listElements.bill` / `.delivery`

Eigenschaft	Typ	Beschreibung
`nodeId`	string	ID des Konfigurationsknotens dieses Eintrags, als zweiter Parameter für `$wsOptions.get(name, nodeId)`.
`defaultValue`	string	Vorausgewählter Wert (z. B. `"1"`).
`values`	array	Optionen, je `{ name, value }`

$wsConfig.passwordChecks

Gibt die Längenregeln für Passwörter aus. Nutzen Sie sie beispielsweise, um in einem Registrierungs- oder Passwort-Formular die erlaubte Länge anzuzeigen oder clientseitig zu prüfen.

Passwortlänge: {{= $wsConfig.passwordChecks.minLength.len }} bis {{= $wsConfig.passwordChecks.maxLength.len }} Zeichen

Eigenschaften von `$wsConfig.passwordChecks`

Eigenschaft	Typ	Beschreibung
`minLength.len`	int	Minimale Passwortlänge.
`maxLength.len`	int	Maximale Passwortlänge.

$wsConfig.passwordReset

Gibt die Einstellungen zum Passwort-Reset aus.

{{ if $wsConfig.passwordReset.checkOldPassword }}
  <!-- Altes Passwort beim Zurücksetzen erforderlich -->
{{ /if }}

Eigenschaften von `$wsConfig.passwordReset`

Eigenschaft	Typ	Beschreibung
`checkLoginID`	bool	Ob die Login-ID beim Reset geprüft wird.
`checkOldPassword`	bool	Ob das alte Passwort beim Reset geprüft wird.

$wsConfig.directOrder

Gibt die Einstellungen der Direktbestellung aus (z. B. wie viele Eingabezeilen angezeigt werden).

Start-Zeilen: {{= $wsConfig.directOrder.initialNumber }}
Max. Zeilen: {{= $wsConfig.directOrder.maximalNumber }}

Eigenschaften von `$wsConfig.directOrder`

Eigenschaft	Typ	Beschreibung
`initialNumber`	int	Anzahl der initial angezeigten Zeilen.
`maximalNumber`	int	Maximale Anzahl von Zeilen.
`refreshedNumber`	int	Anzahl neu geladener Zeilen.
`itemNumberFields`	array	Artikelnummer-Felder der Direktbestellung.

$wsConfig.inserts

Gibt die Einstellungen der Werbemittelkennzeichnung aus. Nutzen Sie insbesondere enabled, um Ausgaben rund um das Werbemittelkennzeichen nur dann anzuzeigen, wenn die Funktion im Shop aktiv ist.

{{ if $wsConfig.inserts.enabled }}
  <!-- Ausgaben zum Werbemittelkennzeichen -->
{{ /if }}

Eigenschaften von `$wsConfig.inserts`

Eigenschaft	Typ	Beschreibung
`enabled`	bool	Ob die Werbemittelkennzeichnung im Shop aktiv ist. Nur dann werden Codes erfasst, aufgelöst und ausgegeben.
`separator`	string	Trennzeichen zwischen Produktnummer und Code (z. B. `-`).
`position`	string	Position des Codes relativ zur Produktnummer: `before` (davor) oder `after` (dahinter).
`defaultInsertCode`	string	Standardcode, der greift, wenn kein oder ein ungültiger Code erfasst wurde. Kann leer sein.

$wsConfig.emails

Gibt die E-Mail-Konfigurationen aus. Jeder Eintrag enthält zusätzlich das Feld nodeId, die ID des Konfigurationsknotens, nutzbar als zweiter Parameter für $wsOptions.get(name, nodeId) (siehe Optionen).

{{= $wsConfig.emails | json }}

$wsConfig.redirects

Gibt die Weiterleitungs-Konfigurationen aus. Jeder Eintrag enthält zusätzlich das Feld nodeId, die ID des Konfigurationsknotens, nutzbar als zweiter Parameter für $wsOptions.get(name, nodeId) (siehe Optionen).

{{= $wsConfig.redirects | json }}

Methoden

Für $wsConfig stehen keine Methoden zur Verfügung.

Aktionen

Für $wsConfig stehen keine Aktionen zur Verfügung.

Beispiele

Länder-Auswahlfeld

<select name="country">
  {{ foreach $country in $wsConfig.countries }}
    <option value="{{= $country.isoAlpha2 }}">{{= $country.name }}</option>
  {{ /foreach }}
</select>

Ergebnis
Ein Auswahlfeld mit allen konfigurierten Ländern. Der Wert ist der ISO-2-Code.

Anrede-Auswahlfeld

<select name="salutation">
  {{ foreach $salutation in $wsConfig.salutation.codeList }}
    <option value="{{= $salutation.code }}">{{= $salutation.text }}</option>
  {{ /foreach }}
</select>

Ergebnis
Ein Auswahlfeld mit allen konfigurierten Anreden.

Zahlungsarten auflisten

{{ foreach $payment in $wsConfig.payments }}
  <p>{{= $payment.name }} – {{= $payment.description }}</p>
{{ /foreach }}

Ergebnis
Alle konfigurierten Zahlungsarten mit Name und Beschreibung.

Währung korrekt anzeigen

Zwischensumme: {{= $wsBasket.totalGross | currency }}

Ergebnis
Der Betrag wird mit Währungssymbol ausgegeben (z. B. 1.500,00 €).

Weiterführende Links

Konfiguration – wo die hier gelesenen Werte gepflegt werden.
Konfiguration per Code – Konfiguration direkt im Template.
$wsCheckout – ermittelt u. a. die Versandkosten je Versandart.
Werbemittelkennzeichen – Übersicht der Werbemittelkennzeichnung, deren Einstellungen $wsConfig.inserts liefert.
ISO-3166-1-Kodierliste – Bedeutung der Ländercodes.

​Grundkonzept

​Währung formatieren

​Modulübersicht

​Templates

​Variablen

​$wsConfig.countries

​Eigenschaften eines Landes

​$wsConfig.currency

​Eigenschaften von $wsConfig.currency

​$wsConfig.salutation

​Eigenschaften eines Eintrags in salutation.codeList

​$wsConfig.title

​Eigenschaften eines Eintrags in title.codeList

​$wsConfig.payments

​Eigenschaften einer Zahlungsart

​$wsConfig.shippingMethods

​Eigenschaften einer Versandart

​$wsConfig.shippingMethodGroups

​Eigenschaften einer Gruppe

​$wsConfig.listElements

​Eigenschaften eines Eintrags in listElements.bill / .delivery

​$wsConfig.passwordChecks

​Eigenschaften von $wsConfig.passwordChecks

​$wsConfig.passwordReset

​Eigenschaften von $wsConfig.passwordReset

​$wsConfig.directOrder

​Eigenschaften von $wsConfig.directOrder

​$wsConfig.inserts

​Eigenschaften von $wsConfig.inserts

​$wsConfig.emails

​$wsConfig.redirects

​Methoden

​Aktionen

​Beispiele

​Länder-Auswahlfeld

​Anrede-Auswahlfeld

​Zahlungsarten auflisten

​Währung korrekt anzeigen

​Weiterführende Links

Grundkonzept

Währung formatieren

Modulübersicht

Templates

Variablen

$wsConfig.countries

Eigenschaften eines Landes

$wsConfig.currency

Eigenschaften von `$wsConfig.currency`

$wsConfig.salutation

Eigenschaften eines Eintrags in `salutation.codeList`

$wsConfig.title

Eigenschaften eines Eintrags in `title.codeList`

$wsConfig.payments

Eigenschaften einer Zahlungsart

$wsConfig.shippingMethods

Eigenschaften einer Versandart

$wsConfig.shippingMethodGroups

Eigenschaften einer Gruppe

$wsConfig.listElements

Eigenschaften eines Eintrags in `listElements.bill` / `.delivery`

$wsConfig.passwordChecks

Eigenschaften von `$wsConfig.passwordChecks`

$wsConfig.passwordReset

Eigenschaften von `$wsConfig.passwordReset`

$wsConfig.directOrder

Eigenschaften von `$wsConfig.directOrder`

$wsConfig.inserts

Eigenschaften von `$wsConfig.inserts`

$wsConfig.emails

$wsConfig.redirects

Methoden

Aktionen

Beispiele

Länder-Auswahlfeld

Anrede-Auswahlfeld

Zahlungsarten auflisten

Währung korrekt anzeigen

Weiterführende Links