Plugin-Funktionen

Mit dem Formular-Manager können Sie aus dem Admin heraus eigene Formulare anlegen, zum Beispiel für ein alternatives Kontaktformular.

Features des Plugins:

  • beliebige Anzahl Formulare
  • beliebige Anzahl Felder pro Formular
  • unterschiedliche Templates pro Formular möglich
  • Unterstützung von Mandanten
  • Unterstützung von Kundengruppen
  • mehrsprachig
  • Empfänger pro Formular definierbar
  • eigener Formular Titel
  • eigene Formular Beschreibung
  • Validierungsregeln anlegbar
  • Validierungsregeln pro Formularfeld auswählbar
  • eigener Feldname
  • eigene Feldbeschreibung
  • Feldvorbelegungen möglich

Systemvoraussetzung

Systemvoraussetzung für dieses Plugin ist xt:Commerce ab Version 4.1. Die Aufwärtskompatibilität ist in der Regel gegeben, kann jedoch nicht zu jedem Zeitpunkt garantiert werden.

Installation

Vorbereitung

Vor der Installation eines Plugins sollten Sie Ihre Daten sichern. Besonders wichtig: die Shopdatenbank.

Installation – Schritt für Schritt

  • 1. Plugin entpacken und die entpackten Ordner und Dateien per FTP in den Ordner Plugins des Shops laden.
  • 2. Die per E-Mail erhaltene Lizenzdatei in den Ordner /lic des Shops laden.
  • 3. Im Adminbereich des Shops das Plugin unter Inhalte → deinstallierte Plugins installieren.
  • 4. Im Adminbereich das Plugin unter Inhalte → installierte Plugins aktivieren (auch für den jeweiligen Mandanten) und konfigurieren.

Nach der Installation laden sie den kompletten Adminbereich neu (in den meisten Browsern mit F5).

Installations- und Update-Service

Falls Sie das Plugin nicht selbst installieren oder updaten möchten, nutzen Sie bitte unseren (kostenpflichtigen) Installations- oder Update-Service.

Template-Anpassung

An der Stelle, an der ein Formular im Template angezeigt werden soll, fügen Sie folgenden Code ein:

„XYZ“ ersetzen Sie durch den entsprechenden Formular-Key, den Sie beim Anlegen oder Bearbeiten eines Formulars selbst festlegen. (Siehe unten: Formulare anlegen)

Formulare anlegen

Formulare, Formularfelder und Werte

Bild oben: Das Plugin legt im Admin unter „Inhalte“ den neuen Menüpunkt „Formular-Manager“ an.

Im Admin finden Sie unter Inhalte den neuen Menüpunkt Formular-Manager mit den Unterpunkten Formulare und Validierungsregeln. Neue Formulare legen Sie an über Formulare → Neu.

Bild oben: Bearbeitungsfenster für Formulare

Beim Neuanlegen oder Bearbeiten eines Formulars haben Sie folgende Einstellungsmöglichkeiten:

  • Status:
    Formular aktivieren oder deaktivieren
  • Formular-Key:
    Tragen Sie hier einen Key ein. Diesen Key benötigen Sie, um das Formular in Ihr Template einzubinden. (Siehe oben: Template-Anpassung)
  • Formular-Template:
    Falls Sie hier ein eigenes Templates für das Formular auswählen möchten, muss die Template-Datei im Ordner /plugins/vt_form_manager/ templates/forms/ liegen.
  • Empfänger-E-Mail:
    Tragen Sie hier die E-Mail-Adresse ein, an die die Formular-Einträge übermittelt werden sollen.
  • Empfänger-Name:
    der Name des Empfängers der Formular-Einträge
  • Formular-Name:
    der Name des Formulars, wie er im Frontend erscheinen soll
  • Formular-Beschreibung:
    Optional können Sie einen weiteren beschreibenden Text eintragen, der im Frontend angezeigt werden soll.

Bild oben: Button „Formular-Felder“ im Bearbeitungsfenster eines Formulars

In der Formularfeld-Übersicht legen Sie neue Formularfelder an über die Schaltfläche Formular-Feld hinzufügen.

Bild oben: Auswahl der Formularfeld-Typen beim Hinzufügen neuer Formularfelder

Beim Hinzufügen von Formularfeldern müssen Sie zu Beginn den Formularfeld-Typ auswählen. Weiter unten finden Sie Beispiele aller Formularfeld-Typen im Frontend.

Bild oben: Bearbeitungsfenster eines Formularfeldes

Nachdem Sie den Typ des Formularfeldes ausgewählt haben, gelangen Sie zu einem Bearbeitungsfenster, in dem Sie folgende Angaben machen können:

  • Validierungs-Regel-ID:
    Falls das Formularfeld mit einer Validierungs-Regel geprüft werden soll — zum Beispiel ob es ein Pflichtfeld sein soll —, können Sie die ID jener Regel hier auswählen. Die Validierungs-Regel muss zuvor angelegt sein (siehe weiter unten im Abschnitt „Validierungsregeln“).
  • Reihenfolge:
    Geben Sie einen Zahlenwert ein. Damit beeinflussen Sie die Reihenfolge des Feldes innerhalb des Formulars.
  • Feldname:
    Tragen Sie den Namen des Formularfeldes so ein, wie er im Frontend erscheinen soll.
  • Feld-Beschreibung:
    Optional können Sie hier einen beschreibenden Text für das Feld eintragen.

Über den Button Vorgabe-Werte oder das gleichnamige Icon in der Feldübersicht können Sie Texte vorgeben, die dann im Frontend erscheinen. Bei den Feldtypen input und textarea sind das Texte, die von den Benutzern überschrieben werden. Bei den Feldtypen radio, checkbox und select sind das die auswählbaren Werte.

Beispiele der Feldtypen im Frontend:

Bild oben: Formularfeld-Typen zur Anzeige und Eingabe von Text

  • headline: erzeugt ein Textlabel zur Gliederung des Formulars
  • input: einzeiliges Feld zur Texteingabe
  • textarea: mehrzeiliges Feld zur Texteingabe

Bild oben: Formularfeld-Typen zum Auswählen vorgegebener Werte

  • radio: erzeugt einen Radio-Button
  • checkbox: eine Checkbox
  • select: eine Auswahlliste

Bild oben: Ausgabe bei Auswahl des Formularfeld-Typs „replay“

Mit dem Formularfeld-Typ replay erzeugen Sie drei Eingabefelder und einen Beschreibungstext zur Abfrage der wichtigsten Kontaktdaten. Bei angemeldeten Benutzern erscheinen die Eingabefelder bereits vorausgefüllt.

Bild oben: Formularfeld-Typen zum Prüfen und Absenden

  • captcha: Erzeugt bei nicht angemeldeten Benutzern eine einzugebende Zeichenfolge, die vor dem Absenden überprüft wird.
  • submit: Button zum Absenden der Formular-Eingaben. Achtung! Es muss ein Formularfeld mit diesem Typ angelegt werden, damit das entsprechende Formular durch den Benutzer abgesendet werden kann. Dieses Feld sollte nach allen anderen Formularfeldern kommen.

Validierungsregeln

Bild oben: Bearbeitungsfenster der Validierungsregeln. Beispiel für ein Pflichtfeld.

Validierungsregeln für Formularfelder legen Sie an über den Inhalte → Formular- Manager → Validierungsregeln → Neu. Dabei haben Sie die folgenden Einstellungsmöglichkeiten:

  • Validierungs-Regel-Name:
    Tragen Sie hier den Namen ein, der dann beim Bearbeiten von Formularfeldern auswählbar sein soll.
  • interne Beschreibung:
    eine optionale Beschreibung der Validierungsregel.
  • Zahlen/Ziffern erlauben:
    Als Eingabe sollen nur Ziffern erlaubt sein.
  • Buchstaben erlauben:
    Als Eingabe sollen nur Buchstaben erlaubt sein.
  • Pflichtfeld? (ja/nein):
    für Felder mit notwendiger Eingabe.
  • min. Länge/Auswahl:
    die Mindestanzahl einzugebender Zeichen oder gewählter Checkboxen
  • max. Länge/Auswahl:
    die maximale Anzahl einzugebender Zeichen oder gewählter Checkboxen

Die Validierungsregeln müssen dann noch bei den entsprechend Formularfeldern ausgewählt werden.

Einbindung eines Formulars in einen bestehenden Shop-Content

Bild oben: Einbindung eines Formulars in einen Shop-Content

Bild oben: Beispiel der shopseitigen Darstellung eines Shop-Contents mit einem eingebunden Formular aus dem Formular-Manager

Die über den Formular-Manager angelegten Formulare können auch in bestehende Shop-Contents, welche über den Contentmanager des Shop verwalten werden, eingebunden werden.

Hierfür sind folgende Schritte nötig:

  • bearbeiten Sie den entsprechenden Content im Admin-Bereich
  • wählen Sie bei „Content Formaular“ den Eintrag „vt_form_manager.php“ in der Auswahlliste aus
  • geben Sie im Feld „Formular-Key (Formular-Manager)“ den Formular-Key des gewünschten Formulars ein, welches Sie einbinden möchten