Formulare und Informationssammlung #

Diese Seite richtet sich an Entwickler, die Formulare auf einer Website brauchen: Kontakt, Feedback, Umfragen, Anmeldung zu Veranstaltungen, Lead-Gewinnung. Exponential baut die meisten davon aus dem Inhaltsmodell: Ein Formular ist ein Objekt einer Klasse, deren Attribute als Informationssammler gekennzeichnet sind; Redakteure legen Formulare an und ändern sie wie jeden Inhalt, und der Kernel speichert und versendet die Antworten.

Inhalt #

1. Wie es funktioniert
2. Eine Formularklasse
3. Das Formular-Template
4. Nach dem Absenden: Ergebnisseite und E-Mail
5. Einstellungen je Formulartyp
6. Antworten lesen und exportieren
7. Spam und Datenschutz
8. Wann Sie stattdessen ein Modul schreiben

Wie es funktioniert #

form object (class with collector attributes), full view
  -> <form> posts to /content/action with ActionCollectInformation
     -> the kernel validates each collector attribute, stores one collection
        -> result page (content/collectedinfo/<type>.tpl) and, if enabled, a mail (content/collectedinfomail/<type>.tpl)

Antworten sind keine Inhaltsobjekte: Sie sind Sammlungen in eigenen Tabellen, die unter Setup > Gesammelte Informationen gelesen werden (Gesammelte Informationen).

Eine Formularklasse #

Legen Sie eine Klasse an (zum Beispiel exp_contact_form) mit:

• normalen Attributen für das, was Redakteure schreiben: einen Titel, eine Einleitung (ezxmltext) und, falls Sie sie verwenden, die Attribute, die collect.ini je Objekt liest (siehe unten);
• Informationssammler-Attributen für das, was Besucher ausfüllen: Textzeile für einen Namen, E-Mail für die Adresse, Textabschnitt für die Nachricht, Auswahlliste für eine Wahl, Kontrollkästchen für eine Einwilligung.

Kennzeichnen Sie die Sammler-Attribute als Erforderlich, wo das Formular sie braucht; der Kernel lehnt unvollständige Antworten dann mit einer Prüfmeldung ab.

Das Formular-Template #

Die Full View des Formularobjekts gibt das Formular aus. Jedes Sammler-Attribut wird mit attribute_view_gui gezeichnet, das das Collect-Template des Datentyps verwendet und ein Eingabefeld ausgibt; die Absende-Schaltfläche heißt ActionCollectInformation, mit den verborgenen Feldern ContentNodeID, ContentObjectID und ViewMode. Ein vollständiges Template mit Beschriftungen und Prüfmeldungen: Formulare in Templates. Gehen Sie vom Formular-Template des Designs aus, auf dem Sie aufbauen, damit die verborgenen Felder und das Formular-Token stimmen, und geben Sie Eingabefeldern IDs für ihre Beschriftungen (Barrierefreie Formulare).

Nach dem Absenden: Ergebnisseite und E-Mail #

Die Ergebnisseite ist content/collectedinfo/<type>.tpl und die E-Mail content/collectedinfomail/<type>.tpl, wobei der Typ aus collect.ini kommt (mitgeliefert: form, poll, feedback). Überschreiben Sie beide in Ihrem Design: die Ergebnisseite für die Dankesnachricht, die E-Mail für Betreff und Text (gesetzt mit {set-block scope=root variable=subject}). Testen Sie E-Mails auf Entwicklungsrechnern mit einem Empfänger unter example.invalid und einem Datei-Transport.

Einstellungen je Formulartyp #

settings/collect.ini bestimmt das Verhalten je Typ und lässt ein Formularobjekt es über ein eigenes Attribut überschreiben:

So kann eine Klasse vielen Formularen dienen, und ein Redakteur kann zum Beispiel je Formular wählen, wohin die Antworten gehen. Legen Sie Ihre Änderungen in collect.ini.append.php Ihrer Erweiterung ab.

Antworten lesen und exportieren #

Setup > Gesammelte Informationen listet die Objekte, die gesammelt haben, mit den Sammlungen jedes Objekts, einem CSV-Export und dem Entfernen nach Bestätigung; dafür ist die Richtlinie infocollector/read nötig. In Templates lesen die Fetch-Funktionen für Inhalte collected_info_count, collected_info_count_list, collected_info_collection und collected_info_list Antworten, etwa um Umfrageergebnisse zu zeigen. Die Erweiterung bccie der Standarddistribution exportiert gesammelte Informationen ebenfalls (Inhalte abbilden: Formulare).

Spam und Datenschutz #

• Fügen Sie öffentlichen Formularen einen Captcha-Datentyp (recaptcha oder hcaptcha) als Sammler-Attribut hinzu (Datentypen wählen).
• Behalten Sie das Formular-Token (ezformtoken) im Template; entfernen Sie keine verborgenen Felder, die das Original ausgibt.
• Erheben Sie nur, was das Formular braucht, sagen Sie im Formular, was mit den Antworten geschieht, und entfernen Sie alte Sammlungen nach Plan; Antworten sind personenbezogene Daten (Datenschutzstandards).
• Geben Sie Antworten nie unmaskiert wieder aus.

Wann Sie stattdessen ein Modul schreiben #

Die Informationssammlung passt zu Formularen, deren Antworten gespeichert und versendet werden. Wenn ein Formular Inhalte anlegen (ein Mitglied reicht einen Artikel ein), ein anderes System aufrufen oder einem mehrstufigen Ablauf folgen muss, schreiben Sie in Ihrer Erweiterung eine Modul-View mit einer Richtlinie, oder lassen Sie Benutzer Inhalte mit content/create, nach Rolle eingeschränkt, anlegen (Module und Views, Formulare und Aktionen).

Verwandte Seiten #

• Gesammelte Informationen
• Workflows und Auslöser
• Benutzer und Registrierung
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.