Module sind von WEBSALE vorgegebene, global verfügbare Module (z. B. $wsAccount). Sie stellen Variablen (Eigenschaften) und Methoden bereit. In der Entwicklung werden sie teilweise auch als View-Module bezeichnet, da sie primär für die Ausgabe (Leseseite) verwendet werden.

In der Entwicklung werden sie auch als View-Module bezeichnet, da sie primär für die Ausgabe (Leseseite) verwendet werden.

Mit diesen Modulen stehen Shopdaten für die Template-Ausgabe zur Verfügung, z. B. zu Produkten, Kategorien oder Käuferdaten.

Eigene Module können nicht erstellt oder erweitert werden.

Inhaltsverzeichnis

1 Schreibweise & Zugriff
2 Variablen & Methoden
- 2.1 Variablen (Eigenschaften)
- 2.2 Methoden
3 Verfügbare Module
4 Aktionen $wsActions
5 Weiterführende Links

Schreibweise & Zugriff

Schreibweise: $ws<Modulname> (z. B. $wsAccount, $wsBasket, $wsProduct)
Module enthalten Variablen (Eigenschaften) und Methoden
Der Zugriff erfolgt über den Punkt-Operator (.), z. B. auf Eigenschaften oder Methoden eines Moduls
Datenfelder und Funktionen werden einheitlich über . angesprochen

Syntax-Beispiel

$ws<Modulname>.<Methode> ???

Mehr Informationen zum Datenzugriff finden Sie hier.

Variablen & Methoden

Ein Modul stellt in der Regel beides bereit:

Variablen (Eigenschaften)
Methoden

Variablen (Eigenschaften)

Über die Variablen liefert das Modul direkt den Wert, der direkt ausgelesen werden kann.

Beispiel - Gibt an, ob der Benutzer eingeloggt ist

{{ = $wsAccount.isLoggedIn }}

Methoden

Die Methoden führen den Aufruf für das Modul aus (z. B. Laden von Daten) und liefern ein Ergebnis zurück.

Beispiel - Lädt die Adresse mit der angegebenen Id

{{ = $wsAccount.loadAddress(addressId) }}

Viele Module liefern strukturierte Daten (z. B. „Maps“/Objekte). Auf deren Felder wird am übersichtlichsten über benutzerdefinierte Variablen zugegriffen, die einmalig im Template belegt wird.

Beispiel - Laden von den Daten des Produktes mit der ID 123456

{{ var $myVariable = $wsProducts.load(productId) }}

Über die benutzerdefinierte Variable $myVariable erfolgt der Zugriff auf einzelne Eigenschaften über $myVariable.<Feld>:

{{ = $myVariable.name }}
{{ = $myVariable.descr }}

Variablen- und Methodenaufrufe können nicht beliebig verkettet werden. Der folgende Aufruf ist daher nicht möglich:

{{ $wsAccount.loadAddress(addressId).isLoggedIn }}

Verfügbare Module

Hier finden Sie eine Übersicht aller Module, die im WEBSALE Shop grundsätzlich verfügbar sind:

$wsAccount — In diesem Abschnitt werden die verfügbaren Variablen und Methoden des $wsAccount Moduls beschrieben, mit denen Sie Account- und Adressdaten dynamisch im Frontend verwenden können.
$wsActions
$wsBasket
$wsCategories
$wsCheckout
$wsComputopHosted
$wsConfig
$wsConsent
$wsCookies
$wsDirectOrder
$wsEmails
$wsExternalData
$wsForm
$wsLastSeenProducts
$wsMaintenance
$wsNavigation
$wsOptIn
$wsOrderHistory
$wsPayPalCheckout
$wsProducts
$wsProductRating
$wsSecurity
$wsSession
$wsShipTrack
$wsStores
$wsStripe
$wsSubshop
$wsTestMode
$wsViews — Mit dem $wsViews Modul können Sie auf Informationen zur aktuellen Seite zugreifen und URLs zu anderen Shop-Seiten generieren. Typische Anwendungsfälle sind SEO-Optimierung (Meta-Tags, hreflang), Navigation und bedingte Inhalte basierend auf dem aktuellen Template. In diesem Abschnitt erfahren Sie, wie Sie auf Seitendaten zugreifen und SEO-freundliche URLs erzeugen können.
$wsVoucher
$wsWatchList
$wsInventory
$wsNewsletter

Aktionen `$wsActions`

Parallel zu den Modulen gibt es Aktionen, die mit $wsActions beginnen.

Während Module Zustände und Daten anzeigen/auslesen, sind Aktionen die Gegenrichtung: Sie dienen dazu, Daten zu erstellen, zu ändern oder zu löschen – typischerweise ausgelöst durch eine Benutzerinteraktion (z. B. Link, Button, Formular).

Mehr Informationen dazu finden Sie unter Referenz → Aktionen

Weiterführende Links

https://websale.atlassian.net/wiki/spaces/WSDOKU/pages/2853830725/Datenzugriff+Anzeige
https://websale.atlassian.net/wiki/spaces/WSDOKU/pages/2398322704/Aktionen

Module