Tipps für .8 Modul-Entwickler VI: pnForm

CMS Anleitungen : pnForm ist eine Erweiterung für pnRender, mit der sich ab Postnuke .8 Formulare erzeugen und die Eingaben der Benutzer validieren lassen. Für die Arbeit an Publish! habe ich ein wenig mit diesem System herumgespielt und vermutlich nur an der Oberfläche gekratzt. Es handelt sich aber offenbar um ein feines System, das einem die nervige Arbeit der Eingabevalidierung komplett abnimmt.

Meine Ansatzpunkt war der Beitrag zu pnForm im englischen Wiki. Das dortige Beispiel ist aber zur Zeit noch etwas knapp beschrieben. Vielleicht werde ich das nach diesem Artikel ändern.

Das Formularsystem besteht aus 3 Teilen:

1. In einer normalen Funktion wird ein neues Formular-Object instantiiert:

zurückgegeben wird das Object, dem ein Template und ein sogenannter Handler zugewiesen werden. In dem Template wird natürlich das Formular erstellt und der Handler ist eine Klasse, die die Benutzereingaben übernimmt, überprüft und erst speichert, wenn alles korrekt ist. Sind Fehler in der Eingabe, wird das Formular mit einem entsprechenden Hinweis erneut angezeigt. Um all das muss sich der Modul-Programmierer nicht mehr kümmern.

2. Das Formular-Template ist ein ganz normales pnRender-Template, in dem man HTML und alle bekannten pnRender-Funktionen benutzen kann. Dadurch aber, dass das Template weiß, dass es ein Formular sein soll, stehen auch die Plugins von pnForm zur Verfügung. Außerdem weiß das Template, wohin die Daten geschickt werden sollen, wenn das Formular abgeschickt wird.

Mit pnForm wird das Formular geöffnet und geschlossen.
pnFormValidationSummary gibt die Fehlermeldung aus, wenn Eingaben falsch waren.
Bei den anderen Plugins kann man schon so erkennen, dass damit ein Label ein Datumsfeld und die Buttons für Abbrechen und Speichern erzeugt werden.

Beim Datumsfeld sieht man aber schon den Vorteil von pnForm: Im Template steht nur ein kurzer Aufruf. pnRender erzeugt daraus nicht nur ein einfaches Input-Feld, sondern setzt dahinter ein kleines Kalender-Bildchen. Wenn man dort draufklickt, geht ein Popup mit einem JavaScript-Kalender auf, über den man bequem das Datum auswählen kann. Außerdem wird das Feld markiert, wenn der Handler zurückmeldet, dass das Datum falsch ist.

BTW: Die Plugin-Namen werden vor dem nächsten Milestone noch alle auf Kleinbuchstaben umgestellt, damit sie benannt sind, wie die anderen Core-Plugins auch.

3. Der Handler besteht aus 2 Funktionen in einer Klasse, die einfach in der selben Datei eingefügt werden kann, in der auch schon die oben genannte Funktion liegt.

In der initialize-Funktion können die Werte an das Formular übergeben werden, die im Formular vorgegeben sein sollen. In der Administration zum Beispiel ist es mehr als praktisch, wenn in den Formularen die Werten eingetragen sind, die bisher gespeichert wurden.

In der HandleCommand-Funktion werden dann die Aktionen durchgeführt, die ausgelöst werden, wenn das Formular abgeschickt wird. Wie man im Template sieht, hat der Absende-Button den Parameter commandName="Update" - dieser wird in dieser Funktion gesucht. Dann wird mit der Zeile $pnRender->pnFormIsValid() geschaut, ob die Eingaben valide sind (Ja! Mit einer Zeile!) - und nur wenn sie es sind, werden sie gespeichert. In diesem Fall in einer Modulvariablen. Aber man kann hier natürlich auch andere Datenbank Aktionen durchführen.

Bei der Arbeit mit pnForms ist mir aufgefallen, dass einige Dinge noch nicht ganz rund sind - das System funktioniert aber und wer schon jetzt damit arbeitet, wird vermutlich bis zum final Release von .8 nur wenige Sachen anpassen müssen.