...
| Table of Contents | ||
|---|---|---|
|
Tables
| Name | Description |
|---|---|
| con_pifa_form | this data table stores forms for the clients and their languages |
| con_pifa_field | this table stores structure of form fields and their properties |
| Info |
|---|
Formular assistant also creates data tables, which are defined in backend of form assistant. The names of the data tables can be free defined. The defined name is always refered to the form. |
Classes
| Name | Description |
|---|---|
| cContentTypePifaForm | content type class for CMS_PIFAFORM |
| PifaAbstractFormModule | abstract class for form module |
| PifaAbstractFormProcessor | abstract class for form processor |
| PifaAjaxHandler | form assistant ajax handler class, contains methods which are called through ajax |
PifaException |
| form assistant exception classes | |
| PifaDatabaseException | |
| PifaNotImplementedException | |
| PifaIllegalStateException | |
| PifaNotYetStoredException | |
| PifaValidationException | |
| PifaExporter | class for exporting formulars |
| PifaExternalOptionsDatasourceInterface | this class allows add external sources for pifa fields like select options or checkboxes |
| PifaFieldCollection | Item collection class for the form field |
| PifaField | Item class for the form field |
| PifaFormCollection | Item collection class for the form |
| PifaForm | Item class for the form |
PifaLeftBottomPage | GUI classes used in plugin |
| PifaRightBottomFormPage | |
| PifaRightBottomFormFieldsPage | |
| PifaRightBottomFormDataPage | |
| PifaRightBottomFormExportPage | |
| PifaRightBottomFormImportPage | |
| PifaImporter | importer class to import forms from xml |
Templates
| Info | ||
|---|---|---|
| ||
This part should be translated to english. |
Im Editor-Dialog des ContentTypen CMS_PIFAFORM können mehrere Templates definiert werden.
- Klassen & Vorlagen | Vorlagen - GET: Vorlage für die Darstellung des Formulares
- Klassen & Vorlagen | Vorlagen - POST: Vorlage für die Darstellung einer Erfolgsmeldung nach dem Absenden des Formulares
- Benutzer-Mail | Vorlagen: Vorlage für Erstellung einer Mail an den Benutzer der das Formular ausgefüllt hat
- System-Mail | Vorlagen: Vorlage für Erstellung einer Mail an den Betreiber der Website
Vorlagen werden im Verzeichnis "templates" des Mandanten abgelegt und können auch über das CONTENIDO Backend gepflegt werden.
Damit Vorlagen vom PIFA erkannt werden müssen deren Namen folgenden Namenskonventionen entsprechen:
- GET-Vorlage: /cms_pifaform_[^\.]+_get\.tpl/
- POST-Vorlage: /cms_pifaform_[^\.]+_post\.tpl/
- Benutzer-Mail-Vorlage: /cms_pifaform_[^\.]+_mail_client\.tpl/
- System-Mail-Vorlage: /cms_pifaform_[^\.]+_mail_system\.tpl/
Settings
| Area/Type | Name | Description | Default | Scope |
|---|---|---|---|---|
| pifa | field-css-classes | 'half-row,full-row,line-bottom,line-top' | SCGU | |
| pifa | timestamp | 'always', 'byform', 'never' | 'always' | SCGU |
| pifa-recaptcha | sitekey | The web page sitekey provided by Google reCAPTCHA | SCGU | |
| pifa-recaptcha | secret | The web page secret provided by Google reCAPTCHA | SCGU |
PIFA Extensions
| Info | ||
|---|---|---|
| ||
This part should be translated to english. |
...
Um der erzeugten Mail auch die Formulardaten als CSV-Datei anzuhängen schreibst du dir einen eigenen FormProcessor (z.B. MaildCsvFormProcessor) und kopierst den Code aus dem MailedFormProcessor. Mittels PifaAbstractFormProcessor::getForm() holst du dir das Formular, dessen Daten du wiederum mittels PifaForm::getValues() erhältst. Daraus kannst du dir nun deinen Anhang bauen. Alternativ kannst du dir auch die Methode PifaForm::getCsv() anschauen, vielleicht kannst du ja mit der was anfangen.
Anbindung von Google reCAPTCHA
Ab CONTENIDO Version 4.9.13 ist der Formular-Assistent in der Lage, Google reCAPTCHA anzubinden.
Damit ein Formular ein solches Captcha-Feld korrekt verarbeiten kann muss einmalig bei Google reCAPTCHA ein Schlüsselpaar erzeugt und in den Mandanteneinstellungen hinterlegt werden (siehe Abschnitt "Settings").
Format der XML-Export-Datei
...
Das "form"-Element dient der Definition des Formulares als solches. Angaben dazu werden als Attribute gespeichert. Zudem enthält es (optional) "field"-Elemente zur Definition der einzelnen Formularfelder welche weiter unten erläutert werden. Das "form"-Element unterstützt folgende Attribute:
| Attribut | Werte | Beschreibung |
|---|---|---|
| name | Zeichenkette | Der Name des Formulares, so wie er im Backend in der linken Navigation ausgegeben wird. |
| table | Zeichenkette | Der Name der Datenbank-Tabelle zur Speicherung der Formulardaten. |
| method | get | post | Anfragemethode beim Absenden des Formulares. |
| timestamp | true | false | Ob beim Speichern von Formulardaten auch ein Zeitstempel erfaßt werden soll. Siehe Setting "pifa/timestamp". |
FIELD - Struktur der Formularfelder
Für jedes Formularfeld wird genau ein "field"-Element definiert. Einige Angaben zum Formularfeld werden als Attribute, andere als Kindelemente notiert. Das "field"-Element unterstützt folgende Attribute:
| Attribut | Werte | Beschreibung | ||
|---|---|---|---|---|
| rank | Zahl | Die Position des Formularfeldes im Formular.
| ||
| type | inputtext, textarea, inputpassword, inputradio, inputcheckbox, select, selectmulti, datepicker, inputfile, processbar, slider, buttonsubmit, buttonreset, buttonback, matrix, paragraph, inputhidden, fieldset_begin, fieldset_end | Der Typ des Formularfeldes, der auch den Tabellentyp der Datenbank-Spalte bestimmt. | ||
| column | Zeichenkette (erlaubt sind hier die Zeichen a-z, A-Z, 0-9 und _ [Unterstrich]) | Der Name der Datenbank-Spalte zur Speicherung der Formulardaten. | ||
| obligatory | true | false | Ob es sich bei diesem Feld um ein Pflichtfeld handelt oder nicht. |
Einige Angaben zu Formularfeldern werden als Kindelemente definiert. Dies sind:
| Element | Werte | Beschreibung | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| label | Zeichenkette | Die Beschriftung des Formularfeldes, so wie sie im Frontend ausgegeben wird.
| ||||||||||||||
| help | Zeichenkette | Der optionale Hilfetext zu einem Formularfeld.
| ||||||||||||||
| error | Zeichenkette | Die optionale Fehlermeldung zu einem Formularfeld.
| ||||||||||||||
| rule | Zeichenkette | Die optionale Validierungsregel zu einem Formularfeld. Hierbei handelt es sich um einen regulären Ausdruck.
| ||||||||||||||
| classes | "class"-Elemente | Mit dem Element "classes", das weitere "class"-Elemente enthält, werden die Namen der CSS-Klassen definiert die für ein Formularfeld ausgegeben werden sollen.
| ||||||||||||||
| options | "option"-Elemente | Mit dem Element "options", das weitere "option"-Elemente enthält, werden die Optionen für Formularfelder der Typen inputradio, select und selectmulti definiert. Deren Wert gibt die Beschriftung an, die im Frontend ausgegeben wird, wogegen deren "value"-Attribut den Wert angibt, der in der Datentabelle gespeichert wird.
Wenn die Optionen higegen aus einer externen Datenquelle bezogen werden sollen, wird das "options"-Element mit dem Attribut "source" anstelle von "option"-Elementen notiert. Dieses enthält dann den Namen der Extension-Klasse die zum Bezug der Options verwendet wird.
|