Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

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. 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.

​
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:

​
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