Mit dem $wsConfig Modul können Sie Konfigurationsdaten des Shops dynamisch im Frontend verwenden (Länder, Währung, Zahlungs- und Versandarten, etc.).

Inhaltsverzeichnis

1 Modulübersicht
2 Templates
3 Variablen
- 3.1 $wsConfig.countries
  - 3.1.1 $wsConfig.countries[$i].name
  - 3.1.2 $wsConfig.countries[$i].isoAlpha2
  - 3.1.3 $wsConfig.countries[$i].isoAlpha3
  - 3.1.4 $wsConfig.countries[$i].isoNum
- 3.2 $wsConfig.currency
  - 3.2.1 $wsConfig.currency.symbol
  - 3.2.2 $wsConfig.currency.isoCode
  - 3.2.3 $wsConfig.currency.isoNum
- 3.3 $wsConfig.directOrder
- 3.4 $wsConfig.emails
- 3.5 $wsConfig.listElements
- 3.6 $wsConfig.passwordReset
- 3.7 $wsConfig.salutation
  - 3.7.1 $wsConfig.salutation.codeList
    - 3.7.1.1 $wsConfig.salutation.codeList[$i].code
    - 3.7.1.2 $wsConfig.salutation.codeList[$i].text
- 3.8 $wsConfig.title
  - 3.8.1 $wsConfig.title.codeList
    - 3.8.1.1 $wsConfig.title.codeList[$i].code
    - 3.8.1.2 $wsConfig.title.codeList[$i].text
- 3.9 $wsConfig.payments
  - 3.9.1 $wsConfig.payments[$i].description
  - 3.9.2 $wsConfig.payments[$i].image
  - 3.9.3 $wsConfig.payments[$i].id
  - 3.9.4 $wsConfig.payments[$i].name
  - 3.9.5 $wsConfig.payments[$i].displayInfo
- 3.10 $wsConfig.redirects
- 3.11 $wsConfig.shippingMethods
  - 3.11.1 $wsConfig.shippingMethods[$i].type
  - 3.11.2 $wsConfig.shippingMethods[$i].link
  - 3.11.3 $wsConfig.shippingMethods[$i].id
  - 3.11.4 $wsConfig.shippingMethods[$i].name
  - 3.11.5 $wsConfig.shippingMethods[$i].description
  - 3.11.6 $wsConfig.shippingMethods[$i].image
4 Methoden
5 Aktionen
6 Beispiele für die Anzeige der Konfigurationsdaten
- 6.1 countries
- 6.2 currency - Währung
- 6.3 directOrder
- 6.4 passwordChecks
- 6.5 payments - Zahlungsarten
- 6.6 salutation
- 6.7 shippingMethods - Versandarten
- 6.8 title
7 Weiterführende Links

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": [...],
  "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": "..."
    }
  ],
  "title": {
    "codeList": [
      { "code": "...", "text": "..." }
    ]
  }
}

Variablen in der Übersicht

Variable	Typ	Beschreibung

Variable	Typ	Beschreibung
`countries`	array	Liste mit konfigurierten Ländern.
`[$i].isoAlpha2`	string	ISO-2 Ländercode (z.B. `“DE”`, `“AT”` )
`[$i].isoAlpha3`	string	ISO-3 Ländercode (z.B. `“DEU”`, `“AUT”`)
`[$i].isoNum`	string	ISO-Zifferncode (z.B: `“276”`, `“040”`)
`[$i].name`	string	Name des Landes.
`currency`	map	Map mit konfigurierten Währungsdaten.
`symbol`	string	Währungssymbol
`isoCode`	string	ISO-3 Währungscode (z.B. `“EUR”`)
`isoNum`	string	ISO-Zifferncode der Währung (z.B. `“978”`)
`salutation`	array	Liste der konfigurierten Anreden.
`directOrder`	map	Map mit Direktbestellung-Einstellungen.
`initialNumber`	int	Anzahl der initial angezeigten Zeilen.
`maximalNumber`	int	Maximale Anzahl von Zeilen.
`refreshedNumber`	int	Anzahl neu geladener Zeilen.
`itemNumberFields`	array	Liste mit Artikelnummer-Feldern.
`emails`	array	Liste mit E-Mail-Konfigurationen.
`listElements`	map	Map mit Adresstyp-Optionen für Formulare.
`bill`	map	Adresstyp-Optionen für Rechnungsadresse.
`delivery`	map	Adresstyp-Optionen für Lieferadresse.
`passwordChecks`	map	Map mit Passwort-Validierungsregeln.
`maxLength.len`	int	Maximale Passwortlänge.
`minLength.len`	int	Minimale Passwortlänge.
`passwordReset`	map	Map mit Passwort-Reset-Einstellungen.
`checkLoginID`	bool	Login-ID bei Passwort-Reset prüfen?
`checkOldPassword`	bool	Altes Passwort bei Passwort-Reset prüfen?
`codeList`	array	Liste der konfigurierten Anreden mit Code / Text.
`[$i].code`	string	Anrede-Code
`[$i].text`	string	Anrede-Text (z.B. `“Herr”`, `“Frau”`, `“Divers”`)
`title`	map	Map mit konfigurierten Titeln.
`codeList`	array	Liste der konfigurierten Titel mit Code / Text.
`[$i].code`	string	Titel-Code
`[$i].text`	string	Titel-Text (z.B. `“Dr.”`, `“Prof.”`)
`payments`	array	Liste der konfigurierten Zahlungsarten.
`[$i].id`	string	ID der Zahlungsart.
`[$i].name`	string	Name der Zahlungsart.
`[$i].description`	string	Beschreibung der Zahlungsart.
`[$i].image`	string	Bild-URL der Zahlungsart.
`[$i].displayInfo`	array	Liste mit Anzeigeinformationen zur Zahlungsart.
`redirects`	array	Liste mit Weiterleitungs-Konfigurationen.
`shippingMethods`	array	Liste der konfigurierten Versandarten/Lieferarten.
`[$i].id`	string	ID der Versandart.
`[$i].name`	string	Name der Versandart.
`[$i].description`	string	Beschreibung der Versandart.
`[$i].image`	string	Bild-URL der Versandart.
`[$i].link`	string	Link zur Versandart (z.B. Tracking).
`[$i].type`	string	Typ der Versandart (z.B. `“standard”`).

Templates

Die Konfigurationsdaten können auf jeder Seite des Shops verwendet werden. Typische Einsatzgebiete sind Formulare (z.B. Länderauswahl, Anrede), der Checkout (Zahlungs- und Versandarten) sowie die Preisanzeige (Währung).

Variablen

$wsConfig.countries

Gibt eine Liste mit konfigurierten Ländern aus.

{{ foreach $country in $wsConfig.countries }}
  Land: {{= $country.name }}
{{ /foreach }}

$wsConfig.countries[$i].name

Gibt den Namen des Landes aus.

Land: {{= $wsConfig.countries[0].name }}

$wsConfig.countries[$i].isoAlpha2

Gibt den ISO-2-Ländercode aus (z.B: “DE”, “AT”).

ISO-2-Code: {{= $wsConfig.countries[0].isoAlpha2 }}

$wsConfig.countries[$i].isoAlpha3

Gibt den ISO-3-Ländercode aus (z.B. “DEU”, “AUT”).

ISO-3-Code: {{= $wsConfig.countries[0].isoAlpha3 }}

$wsConfig.countries[$i].isoNum

Gibt den ISO-Zifferncode des Landes aus (z.B. ‘276’).

ISO-3-Zifferncode: {{= $wsConfig.countries[0].isoNum }}

$wsConfig.currency

Gibt eine Map mit Währungsdaten aus.

Summe: {{= $wsBasket.totalGross | currency }} {{= $wsConfig.currency.symbol }}

$wsConfig.currency.symbol

Gibt das Währungssymbol der konfigurierten Währung aus.

Währungssymbol: {{= $wsConfig.currency.symbol }}

$wsConfig.currency.isoCode

Gibt den ISO-3-Währungscode der konfigurierten Währung aus (z.B. “EUR”).

ISO-3-Code: {{= $wsConfig.currency.isoCode }}

$wsConfig.currency.isoNum

Gibt den ISO-Zifferncode der konfigurierten Währung aus (z.B. “987”).

ISO-Zifferncode: {{= $wsConfig.currency.isoNum }}

$wsConfig.directOrder

Gibt Einstellungen für die Direktbestellung aus.

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

$wsConfig.emails

Gibt eine Liste mit E-Mail-Konfigurationen aus.

{{ foreach $myEmail in $wsConfig.emails }}
  {{= $myEmail }}
{{ /foreach }}

$wsConfig.listElements

Gibt Adresstyp-Optionen für Formulare aus (z.B. Privat / Firma).

{{ if $wsConfig.listElements.bill }}
  // Adresstyp-Optionen verfügbar
{{ /if }}

$wsConfig.passwordReset

Gibt Passwort-Reset-Einstellungen aus.

{{ if $wsConfig.passwordReset.checkOldPassword }}
  // Altes Passwort erforderlich
{{ /if }}

$wsConfig.salutation

Gibt eine Liste der konfigurierten Anreden des Shops aus.

Properties von $wsConfig.salutation

$wsConfig.salutation.codeList

Liste aller konfigurierten Anreden mit Code / Text.

Beispiel, das alle konfigurierten Anreden durchläuft und den Anrede-Text ausgibt.

{{ foreach $mySalutationVariable in $wsConfig.salutation.codeList }}
  {{= $mySalutationVariable.text }}<br>
{{ /foreach }}

$wsConfig.salutation.codeList[$i].code

Gibt den Code der Anrede aus (z.B. “mr”, “ms”).

Anrede-Code: {{= $wsConfig.salutation.codeList[0].code }}

$wsConfig.salutation.codeList[$i].text

Gibt den Anzeigetext der Anrede aus (z.B. “Herr”, “Frau”).

Anrede-Text: {{= $wsConfig.salutation.codeList[0].text }}

$wsConfig.title

Gibt eine Map mit konfigurierten Titeln des Shops aus.

Properties von $wsConfig.title

$wsConfig.title.codeList

Gibt eine Liste mit Code und Text aller konfigurierter Titel im Shop aus.

{{ foreach $myTitleVariable in $wsConfig.title.codeList }}
  {{= $myTitleVariable.text }}<br>
{{ /foreach }}

$wsConfig.title.codeList[$i].code

Beispiel, das den konfigurierten Code zum ersten Titel in der Liste ausgibt.

Titel-Code: {{= $wsConfig.title.codeList[0].code }}

$wsConfig.title.codeList[$i].text

Beispiel, das den Text zum ersten Titel in der Liste ausgibt (z.B. “Dr.”, “Prof.”)

Titel-Text: {{= $wsConfig.title.codeList[0].text }}

$wsConfig.payments

Gibt eine Liste mit konfigurierten Zahlungsarten aus.

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

$wsConfig.payments[$i].description

Gibt die Beschreibung der Zahlungsart aus.

Beschreibung: {{= $wsConfig.payments[0].description }}

$wsConfig.payments[$i].image

Gibt die Bild-URL der Zahlungsart aus.

Bild-URL: {{= $wsConfig.payments[0].image }}

$wsConfig.payments[$i].id

Gibt die ID der Zahlungsart aus.

Zahlungsart-ID: {{= $wsConfig.payments[0].id }}

$wsConfig.payments[$i].name

Gibt den Namen der Zahlungsart aus.

Zahlungsart-Name: {{= $wsConfig.payments[0].name }}

$wsConfig.payments[$i].displayInfo

Gibt die konfigurierten Anzeigeinformationen einer Zahlungsart als Liste aus. Der Eintrag displayInfo ist nur dann befüllt, wenn für die Zahlungsart der Parameter displayPaymentTypes konfiguriert wurde.

Jedes Objekt in der Liste enthält folgende Eigenschaften:

Eigenschaft	Typ	Beschreibung

Eigenschaft	Typ	Beschreibung
`name`	string	Anzeigename der Zahlungsoption.
`description`	string	Beschreibungtext der Zahlungsoption.
`image`	string	Link zum Bild bzw. Icon der Zahlungsoption.

Beispiel, das alle displayInfo-Einträge der konfigurierten Zahlungsarten ausgibt:

{{ foreach $myPayment in $wsConfig.payments }}
  {{ foreach $paymentInfo in $myPayment.displayInfo }}
    Name: {{= $paymentInfo.name }}
    Beschreibung: {{= $paymentInfo.description }}
    Bild: {{= $paymentInfo.image }}
  {{ /foreach }}
{{ /foreach }}

$wsConfig.redirects

Gibt eine Liste mit Weiterleitungs-Konfigurationen aus.

{{ if $wsConfig.redirects }}
  // Weiterleitungs-Konfiguration
{{ /if }}

$wsConfig.shippingMethods

Gibt eine Liste mit konfigurierten Versandarten aus.

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

$wsConfig.shippingMethods[$i].type

Gibt den Typ der Versandart aus (z.B. “standard”).

{{ foreach $shipping in $wsConfig.shippingMethods }}
  {{ if $shipping.type == "standard" }}
    {{= $shipping.name }}
  {{ /if }}
{{ /foreach }}

$wsConfig.shippingMethods[$i].link

Gibt den Link zur Versandart aus (z.B. Tracking-Seite).

{{ if $shipping.link }}
  <a href="{{= $shipping.link }}">Mehr Infos</a>
{{ /if }}

$wsConfig.shippingMethods[$i].id

Gibt die ID der Versandart aus.

Versandart-ID: {{= $wsConfig.shippingMethods[0].id }}

$wsConfig.shippingMethods[$i].name

Gibt den Namen der Versandart aus.

Versandart-Name: {{= $wsConfig.shippingMethods[0].name }}

$wsConfig.shippingMethods[$i].description

Gibt die Beschreibung der Versandart aus.

Beschreibung: {{= $wsConfig.shippingMethods[0].description }}

$wsConfig.shippingMethods[$i].image

Gibt die Bild-URL der Versandart aus.

Bild-URL: {{= $wsConfig.shippingMethods[0].image }}

Methoden

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

Aktionen

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

Beispiele für die Anzeige der Konfigurationsdaten

countries

In diesem Beispiel durchläuft eine foreach Schleife die in der Konfiguration gespeicherten Länder und weist sie einer Variable zu, über die anschließend auf die jeweiligen Konfigurationsdaten zugegriffen werden kann.

{{ foreach $country in $wsConfig.countries }}
  zweistelliges Länderkürzel: {{= $country.isoAlpha2 }}
  dreistelliges Länderkürzel: {{= $country.isoAlpha3 }}
  ISO-Numeric Länderkürzel: {{= $country.isoNum}}
  Name: {{= $country.name}}
{{ /foreach }}

currency - Währung

In diesem Beispiel wird bei der Zwischensumme des Warenkorbs die Währung des Subshops, sowie das Währungszeichen abgefragt.

Zwischensumme(inkl.MwSt.): {{= $wsBasket.totalGross | currency }} {{= $wsConfig.currency.symbol }}

directOrder

Diese Konfiguration liefert die konfigurierten Anzahl der Positionen der Direktbestellung-Funktion.

Zeilen zu erzeugen: {{= directOrder.initialNumber }}
maximale Anzahl von Zeilen: {{= directOrder.maximalNumber }}

passwordChecks

Bei dieser Konfiguration können die konfigurierten Passwort-Einstellungen abgefragt werden.

Maximale Länge des Passworts: {{= $passwordChecks.maxLength.len }}
Mindestlänge des Passworts: {{= $passwordChecks.minlen }}

payments - Zahlungsarten

In diesem Beispiel werden die hinterlegten Zahlungsarten innerhalb einer foreach Schleife einer Variable zugewiesen, über die anschließend auf die jeweiligen Konfigurationsdaten zugegriffen werden kann.

{{ foreach $cPayment in $wsConfig.payments }}
   Zahlungsart ID:    {{= $cPayment.id }}
   Zahlungsart Name: {{= $cPayment.name }}
{{ /foreach }}

salutation

In diesem Beispiel wird eine Liste der hinterlegten Anreden geladen. Dies kann beispielsweise in Formulare verwendet werden.

{{ foreach $salutationCode in $wsConfig.salutation.codeList }}
   Salutation Code: {{= $salutationCode.code }}
   Salutation Name: {{= $salutationCode.text }}
{{ /foreach }}

shippingMethods - Versandarten

In diesem Beispiel werden die hinterlegten Versandarten innerhalb einer foreach Schleife einer Variable zugewiesen, über die anschließend auf die jeweiligen Konfigurationsdaten zugegriffen werden kann.

{{ foreach $cShipping in $wsConfig.shippingMethods }}
   Versandart ID: {{= $cShipping.id }}
   Versandart Name: {{= $cShipping.name }}
   Versandkosten: {{= $cShipping.cost }}
{{ /foreach }}

title

In diesem Beispiel wird die Liste der hinterlegten Titeln geladen. Dies kann beispielsweise in Formulare verwendet werden.

{{ foreach $titleCode in $wsConfig.title.codeList }}
	Titelcode: {{= $titleCode.code }}
	Titel: {{= $titleCode.text }}
{{ /foreach }}

$wsConfig