Visforms Events zur Plugin Entwicklung
In der Vergangenheit wurden immer wieder Feature-Wünsche an uns herangetragen, die einer sehr individuelle Business-Logik entstammen. Beispiele hierfür sind individuelle Submit-Handler oder spezifische Aktionen auf den Formulardaten, die nach dem erfolgreichen Abschicken des Formulars ausgeführt werden sollen, beispielsweise der sofortige Export in eine kontinuierlich fortgeschriebene serverseitige Text-Datei. Solche individuellen Feature direkt in den Core von Visforms zu implementieren ergibt keinen Sinn. Mit dem in Visforms 3.2.0 eingeführten Event-System ist es möglich, den Visforms Core um Plugins zu erweitern, die solche individuellen Feature implementieren können. Ein weiterer Vorteil ist, dass diese individuell entwickelten Plugins von Updates des Visforms Core nicht überschrieben werden.
Sollten Sie ein solches individuelles Feature benötigen, entwickeln wir gerne ein individuelles Plugin für Sie. Wir erstellen Ihnen gerne ein Angebot. Lassen Sie uns einfach eine Beschreibung der gewünschten Funktionalität zukommen.
Unterstützte Events
- onVisformsBeforeHtmlPrepare
- onVisformsAfterHtmlPrepare
- onVisformsAfterCustomtextPrepare
- onVisformsFormPrepare
- onVisformsEditFormPrepare
- onVisformsBeforeFormSave
- onVisformsAfterFormSave
- onVisformsEmailPrepare
- onVisformsBeforeSuccessAction
onVisformsBeforeHtmlPrepare
Der HTML-Code, der ein komplettes Formularfeld mit allen Formatierungen ergibt, wird vollständig im Visforms Code erzeugt und als fertiger HTML-String an die Formular-View übergeben, abhängig vom Feldtyp, von den in der Felddefinition gesetzten Parametern und vom Formularlayout. Das onVisformsBeforeHtmlPrepare kann verwendet werden, um Feldparameter zu ändern, bevor mit der Erstellung des HTML-Codes begonnen wird.
Parameter
- String $context: com_visforms.field
- Objekt $field: Referenz auf das field Objekt
- String $layout: visforms, btdefault, bthorizontal oder multicolumn
onVisformsAfterHtmlPrepare
Das onVisformsAfterHtmlPrepare Event wird getriggert, nachdem der HTML-Code generiert wurde und bevor dieser an die Formular-View übergeben wird. Es kann verwendet werden, um den fertigen HTML-String nachzubearbeiten
Parameter
- String $context: com_visforms.field
- Objekt $field: Referenz auf das field Objekt
- String $html: Referenz auf den HTML-String
- String $layout: visforms, btdefault, bthorizontal oder multicolumn
onVisformsAfterCustomtextPrepare
Das onVisformsAfterCustomtextPrepare Event wird getriggert, nachdem der HTML-Code für den "benutzerdefinierten Text" generiert wurde. Es kann verwendet werden, um den fertigen HTML-String nachzubearbeiten
Parameter
- String $context: com_visforms.field
- String $html: Referenz auf den HTML-String
- String $layout: visforms, btdefault, bthorizontal oder multicolumn
onVisformsFormPrepare
Das onVisformsFormPrepare Event wird in der Formular View getriggert, bevor das Formular endgültig zur Anzeige gebracht wird. Es kann unter anderem dazu verwendet werden, individuellen Javascript Code in das Formular einzufügen oder um Formularparameter zu verändern und so das Layout des Formulars anzupassen.
Parameter
- String $context: com_visforms.form (Formular wird über Menü angezeigt) oder mod_visforms.form (Formular wird durch Modul angezeigt) oder plg_vfformview.form (Formular wird durch Content Plugin Form View angezeigt)
- Objekt $visforms: Referenz auf das Form Objekt
- Objekt $menu_params: Referenz auf die Menü Parameter
onVisformsEditFormPrepare
Das onVisformsEditFormPrepare Event wird in der Formular Edit View getriggert, bevor das Formular endgültig zur Anzeige gebracht wird. Es kann unter anderem dazu verwendet werden, individuellen Javascript Code in das Formular einzufügen oder um Formularparameter zu verändern und so das Layout des Formulars anzupassen.
Parameter
- String $context: com_visforms.form
- Objekt $visforms: Referenz auf das Form Objekt
- Objekt $menu_params: Referenz auf die Menü Parameter
onVisformsBeforeFormSave
Das onVisformsBeforeFormSave Event wird ausgelöst, bevor die übermittelten Formulardaten in der Datenbank gespeichert werden.
Parameter
- String $context: com_visforms.form
- Objekt $visforms: Referenz auf das Form Objekt
- Array $fields: Referenz auf die Felder Objekte
onVisformsAfterFormSave
Das onVisformsAfterFormSave Event wird ausgelöst, nachdem die übermittelten Formulardaten gespeichert wurden.
Parameter
- String $context: com_visforms.form
- Objekt $visforms: Referenz auf das Form Objekt
- Array $fields: Referenz auf die Felder Objekte
onVisformsEmailPrepare
Das onVisformsEmailPrepare Event wird zwei Mal mit unterschiedlichem Kontext ausgelöst, bevor die Ergebnismail verschickt wird und bevor die Email an den Benutzer verschickt wird. Das Event kann genutzt werden, um individuellen Code ablaufen zu lassen, der die Email verändert, z.B. um eine Datei an die E-Mail anzuhängen.
Parameter
- String $context: com_visforms.form.receiptmail oder com_visforms.form.resultmail
- Objekt $mail: Referenz auf das Mailer Objekt
- Objekt $visforms: Referenz auf das Form Objekt
onVisformsBeforeSuccessAction
Das onVisformsBeforeSuccessAction Event wird ausgelöst, direkt bevor der Redirect Aktion erfolgt.
Parameter
- String $context: com_visforms.form
- Objekt $visforms: Referenz auf das Form Objekt
- Array $fields: Referenz auf die Felder Objekte