Zend Framework FAQ: Wo platziere ich am besten meine Validatoren und Filter, im Controller, im Formular oder im Model?
Samstag, 09.01.2010Bei der zweiten Abstimmung für die Zend Framework Fragestunde, wurde diese Frage mit 29% der Stimmen auf Platz 1 gewählt: Wo platziere ich am besten meine Validatoren und Filter, im Controller, im Formular oder im Model? Setze ich dabei Zend_Filter_Input ein? Es hat ein wenig gedauert (mehr als zwei Monate), bis ich nun endlich dazu gekommen bin, mich dieser Frage anzunehmen. Dies hatte mehrere Gründe, denn ich war sowohl beruflich als auch privat sehr eingespannt. Bin ich eigentlich immer noch, aber heute habe ich mir die Zeit genommen. Sonst wird die Fragestunde auch eher langweilig und wieder schnell vergessen.
Ein Grund, weshalb die Antwort so lange auf sich warten liess, war auch, dass diese Frage auf den ersten Blick gar nicht so leicht zu beantworten ist. Der Frage ist schon zu entnehmen, dass es viele Möglichkeiten gibt. Werden die Validatoren und Filter im Controller, im Formular oder im Model platziert? Verwendet man lieber Zend_Form oder Zend_Filter_Input? Ich werde hier nun zwei Lösungswege vorstellen, möchte aber auch darauf hinweisen, dass es weitere sinnvolle und gute Lösungen gibt. Und eigentlich ist die Frage auch etwas ungenau gestellt. Denn das Platzieren der Validatoren und Filter ist relativ klar. Unklar ist eher, wann und wo das Filtern und Validieren ausgeführt wird. Doch dazu gleich mehr.
Ansatz 1: Zend_Form zum Filtern und Validieren verwenden
Es ist nahe liegend, für das Filtern und Validieren von Eingabedaten Zend_Form zu verwenden. Diese Komponente bietet bereits alles, was man braucht. Es ist recht einfach, einem Formular beliebige Filter und Validatoren zuzuordnen. Dies ist auch meiner Meinung nach gut im Referenzhandbuch für Zend_Form erläutert, so dass ich dies hier nicht wiederholen möchte. Auch im Quickstart findet sich ein Beispiel. Komplizierter ist aber die Frage, wo in einer Anwendung die isValid() Methode einer Zend_Form Instanz aufgerufen wird.
Als erstes bietet sich der Einsatz im Action-Controller an. Dies ist auch nahe liegend, da der Controller unter anderem auch für die Verarbeitung und Weitergabe der Eingabedaten zuständig ist. Ein Model oder gar eine Formularinstanz sollte nie direkt auf die Daten zugreifen, die über den Request des Benutzers eingehen. In der Regel könnte solch ein Abfrage mehr oder minder wie im folgenden Beispiel aussehen. Es wird eine Instanz des Formulars erstellt, dann wird geprüft, ob das Formular gültig ist. Falls ja, wird erst die Instanz des Models erstellt und dann kann wie in diesem Beispiel ein neues Passwort für einen Benutzer erstellt werden.
-
function passwordAction()
-
{
-
// Formular für neues Benutzerpasswort
-
$form = new App_Form_UserPassword();
-
-
// prüfen ob Formular mit Button versandt wurde
-
if ($this->getRequest()->isPost() && !is_null($this->getRequest()->getPost('submit_user_password')))
-
{
-
// prüfen ob Eingaben gültig sind
-
if ($form->isValid($this->getRequest()->getPost()))
-
{
-
// Model Instanz erstellen
-
$user = new App_Model_Users();
-
-
// Neues Passwort generieren
-
$user->generatePassword($form->getValue('user_email'));
-
-
// umleiten auf Bestätigung
-
return $this->_redirect($this->getHelper('url')->url(array('action' => 'password-sent', 'id' => $user->getId())));
-
}
-
-
// Daten sind ungültig
-
else
-
{
-
// Fehlermeldung festlegen
-
$form->setDescription('message_user_password_error');
-
}
-
}
-
-
// Formular an View übergeben
-
$this->view->passwordForm = $form;
-
}
Diese Verwendung ist nahe liegend und sieht auf den ersten Blick auch solide aus. Und es funktioniert auch soweit ganz gut. Das Problem ist nur, was man macht, wenn ein Formular z.B. an verschiedenen Stellen einer Anwendung zum Einsatz kommt. Dann muss in der jeweiligen Aktionsmethode des Action-Controller diese Prüfung laufend wiederholt wird. Ich denke da an den Ansatz der "thin controller and fat models" und möchte die Aktionsmethoden so einfach wie möglich halten. Deshalb möchte ich die eigentliche Prüfung der Daten lieber aus dem Controller heraus in das Model verlagern.
Dies hat auch den Vorteil, dass die Prüfung der Daten auch gewährleistet ist, falls ein Model einen neuen Datensatz anlegen soll, der nicht über ein Web-Formular in der Anwendung landet (z.B. beim Importieren von Daten aus einer externen Quelle). Und es macht keinen Sinn, die Prüfung der Eingabedaten redundant im Controller und im Model zu implementieren.
Zuerst schauen wir uns den Ausschnitt aus dem Model an. Es erstellt eine Instanz des Formulars und überprüft die Korrektheit der Daten, wenn das Formular abgeschickt worden ist. Wenn die Eingaben korrekt ware, wird ein neues Passwort erstellt und gespeichert, danach wird eine Mail mit dem Passwort versandt. Wenn dies nicht geklappt hat oder das Formular nicht versandt wurde, wird die Instanz des Formulars zurück gegeben.
-
class App_Model_Users
-
{
-
{
-
// Formular für neues Benutzerpasswort
-
$form = new App_Form_UserPassword();
-
-
// prüfen ob Formular mit Button versandt wurde
-
// prüfen ob Eingaben gültig sind
-
if ($form->isValid($data)) {
-
// Daten übernehmen, Passwort erstellen und speichern
-
$this->setProperties($form->getValues());
-
$this->setPassword(App_Model_Users::generatePassword());
-
$this->save();
-
-
// Mail mit neuem Passwort aufbauen und versenden
-
$mail = new Zend_Mail();
-
$mail->setFrom('webmaster@mydomain.de');
-
$mail->addTo($this->getEmail());
-
$mail->setSubject('Neues Passwort');
-
$mail->setBodyText('Passwort: ' . $this->getPassword());
-
$mail->send();
-
-
// Registrierung erfolgreich
-
return true;
-
-
} else {
-
// Fehlermeldung festlegen
-
$form->setDescription('message_user_password_error');
-
}
-
}
-
-
// Formularobjekt zurück geben
-
return $form;
-
}
-
}
Als nächstes schauen wir uns den Action-Controller an. Hier wird nun nicht mehr die Instanz des Formulars, sondern die des Models erstellt. Es gibt eine spezielle Methode für das Erstellen eines neuen Passworts. Diese gibt entweder ein true oder eine Formularinstanz zurück.
-
class UserController extends Zend_Controller_Action
-
{
-
public function passwordAction()
-
{
-
// Model für Benutzer instanzieren
-
$user = new App_Model_Users();
-
-
// Passwort erstellen
-
$form = $user->generatePassword($this->getRequest()->getPost());
-
-
// Prüfen auf Redirect
-
if (true === $form) {
-
// umleiten auf Bestätigung
-
return $this->_redirect($this->getHelper('url')->url(array('action' => 'password-sent', 'id' => $user->getId())));
-
}
-
-
// Übergebe Formular an den View
-
$this->view->passwordForm = $form;
-
}
-
}
Wir verwenden nun also das Zend_Form Objekt innerhalb unseres Models und der Action-Controller muss sich um fast nichts mehr kümmern. Nur die Weiterleitung und die Übergabe an den View sind noch für ihn zu erledigen.
Ansatz 2: Zend_Filter_Input zum Filtern und Validieren verwenden
Verzichtet man aus welchen Gründen auch immer auf den Einsatz von Zend_Form, kann man das Filtern und Validieren alternativ auch von Zend_Filter_Input erledigen lassen. Die Funktionsweise ist im Referenzhandbuch erklärt, so dass ich mir die Einführung von Zend_Filter_Input an dieser Stelle sparen möchte.
Der Einsatz innerhalb eines Models ist aber recht schnell dargestellt. Die Unterschiede zum Einsatz von Zend_Form sind marginal.
-
class App_Model_Users
-
{
-
{
-
// Zend_Filter_Input Instanz
-
$input = new App_Filter_UserPassword();
-
-
// prüfen ob Formular mit Button versandt wurde
-
// prüfen ob Eingaben gültig sind
-
if ($input->isValid($data)) {
-
// Daten übernehmen, Passwort erstellen und speichern
-
$this->setProperties($input->getEscaped());
-
$this->setPassword(App_Model_Users::generatePassword());
-
$this->save();
-
-
// Mail mit neuem Passwort aufbauen und versenden
-
$mail = new Zend_Mail();
-
$mail->setFrom('webmaster@mydomain.de');
-
$mail->addTo($this->getEmail());
-
$mail->setSubject('Neues Passwort');
-
$mail->setBodyText('Passwort: ' . $this->getPassword());
-
$mail->send();
-
-
// Registrierung erfolgreich
-
return true;
-
}
-
-
// Nicht erfolgreich
-
return false;
-
}
-
}
Da ich selber Zend_Form sehr gerne und viel einsetze, habe ich Zend_Filter_Input noch nicht so häufig in der Praxis eingesetzt. Aber es ist durchaus möglich, wie das Beispiel zeigt.
Fazit
Das Filtern und Validieren von Eingabedaten ist im Model meistens am besten aufgehoben. Ob man nun Zend_Form oder Zend_Filter_Input einsetzt, bleibt einem selbst überlassen. Beides ist möglich.
Wenn es Fragen gibt oder ihr dies oder jenes völlig anders macht, stehen dafür nun die Kommentare bereit. Ich freue mich auf euer Feedback!
Abgelegt in Fragestunde |
| 6 Kommentare »