PIFA - Form Assistant

Tables

Classes

Templates

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

PIFA Extensions

Im Plugin form_assistant gibt es einen Unterordner namens "extensions". In diesem kann man eigene FormModule- und FormProcessor-Klassen ablegen, die, sofern sie der Namenskonvention (s.u.) folgen und eine Klasse enthalten, die von PifaAbstractFormModule bzw. PifaAbstractFormProcessor erben, automatisch vom PIFA erkannt und im Dialog des ContentTypen CMS_PIFAFORM zur Auswahl angeboten werden.

Namenskonventionen

Extensions sind in Dateien abzulegen dern Namen folgende Form hat: class.pifa.<class_name>.php.
Im Dateinamen ist "class_name" komplett klein zu schreiben und mit Unterstrichen zu trennen!
Die Klasse *in* dieser Datei ist wiederum in der "CamelCase"-Notation zu schreiben. Aus "class_name" wird "ClassName".
Beispiel: Die Klasse MailedFormProcessor findet sich in der Datei class.pifa.mailed_form_processor.php.

Vererbung von Extensions

Eine eigene FormModule-Klasse muß von PifaAbstractFormModule, eine FormProcessor-Klasse von PifaAbstractFormProcessor erben.
Durch die Vererbung stehen einer Instanz der eigenen FormProcessor-Klasse u.a. folgende Methoden zur Verfügung:

public function getModule() {
    // returns instance of defined FormModule
}

public function getForm() {
    // returns instance of PifaForm
}

Implementation einer eigenen FormModule-Klasse

Eine FormModule-Klasse ist für das Verhalten des Formulares zuständig, d.h. wie ein PIFA-Formular auf verschiedene Anfragen (GET bzw. POST) reagiert. Wie man seine eigene FormModule-Klasse implementiert werde ich später erklären.

Implementation einer eigenen FormProcessor-Klasse

Eine FormProcessor-Klasse hingegen ist für die Verarbeitung der erfaßten Daten verantwortlich. Der DefaultFormProcessor z.B. implementiert keine "eigenen" Aktionen, so daß ausschließlich das Verhalten seiner Vaterklasse (PifaAbstractFormProcessor) dafür sorgt, daß die Daten aus der Anfrage gelesen, validiert und in der Datenbank gespeichert werden. (Ich weiß, hier habe ich einen kleinen Fehler in der Architektur begangen.)

Der MailedFormProcessor hingegen erweitert das o.g. Verhalten des PifaAbstractFormProcessor um das Versenden von zwei Mails, einer an die Adresse des Benutzers, eine an das System (z.B. den sysadmin). Um das Verhalten seines FormProcessors zu implementieren kann der Entwickler folgende Methoden überschreiben oder überlagern:

protected function _processReadData() {
}

protected function _processValidatedData() {
}

protected function _processStoredData() {
}

Dabei handelt es sich um "Schablonen"-Methoden die nach dem lesen, validieren bzw. speichern aufgerufen werden.

Ist es mit dem neuen Formular-Assistent möglich die Inhalte des Formulars als Anhang (CSV) zu senden?

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

Mit der Version 1.1 des PIFA steht nun das Feature "Im- und Export von Formularen" zur Verfügung. Hier soll das Format der erzeugten XML-Datei erläutert werden um so auch das händische Erzeugen von Formularen mittels XML zu ermöglichen.

PIFA - Struktur der XML-Datei

Jede PIFA-XML-Datei besteht aus genau einem "pifa"-Element mit genau einem "form"-Element. Optional kann auch maximal ein "data"-Element enthalten sein. Das "form"-Element samt Nachfahren beschreibt die Struktur des Formulares, wogegen das "data"-Element die erfaßten Formulardaten dokumentiert.

<pifa>
	<form>
		<field></field>
		...
	</form>
	<data>
		<row></row>
		...
	</data>
</pifa>

FORM - Struktur des Formulares

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:

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:

Einige Angaben zu Formularfeldern werden als Kindelemente definiert. Dies sind:

<classes>
	<class>foo</class>
	<class>bar</class>
</classes>

<options>
	<option value="1">foo</option>
	<option value="1">bar</option>
</options>

<options source="YourFancyDataSourceClass" />