Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

Code Block
languagephp
linenumberstrue
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.)

...

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.

...

Das "form"-Element dient der Definition des Formulares als solches. Diese werden als Attribute gespeichert. Zudem enthält es (optional) "field"-Elemente zur Definition der einzelnen Formularfelder welche weiter unten erläutert werden. Folgende Attribute werden unterstütztDas "form"-Element unterstützt folgende Attribute:

AttributWerteBeschreibung
nameZeichenketteDer Name des Formulares, so wie es im Backend in der linken Navigation ausgegeben wird.
tableZeichenketteDer Name der Datenbank-Tabelle zur Speicherung der Formulardaten.
methodget | postAnfragemethode beim Absenden des Formulares.
timestamptrue | falseOb beim Speichern von Formulardaten auch ein Zeitstempe erfaßt werden soll. Siehe Setting "pifa/timestamp".

FIELD - Struktur der Formularfelder

Für jedes Formulareld wird genau ein "field"-Element definiert. Einige Angaben zum Formularfeld werden als Attribute, andere als Kindelemente definiert. Das "field"-Element unterstützt folgende Attribute:

AttributWerteBeschreibung
rankZahl

Die Position des Formularfeldes im Formular.

Info
Die Reihenfolge der Felder in der XML-Datei ist dabei irrelevant.
typeZeichenkette 
columnZeichenketteDer Name der Datenbank-Spalte zur Speicherung der Formulardaten.
obligatorytrue | falseOb es sich bei diesem Feld um ein Pflichtfeld handelt oder nicht.
Code Block
languagexml
linenumberstrue
<form name="contact" table="con_pifa_contact" method="post" timestamp="true">
	<field rank="1" type="select" column="salutation" obligatory="true">
		<label display="true">Anrede</label>
		<error>Bitte wählen Sie die Anrede aus</error>
		<options>
			<option>Bitte wählen</option>
			<option value="Mrs">Frau</option>
		</options>
	</field>
</form>

...