Die Erstellung eines Form Objektes ist sehr einfach: nur Zend_Form instanziieren:

<?php
$form = new Zend_Form;
?>

Für fortgeschrittene Anwendungsfälle, kann man eine Zend_Form Subklasse erstellen, aber für einfache Forms, kann eine Form programmtechnisch mit einem Zend_Form erstellt werden.

Wenn man eine Form Aktion und Methode spezifizieren will (immer eine gute Idee), kann das mit den setAction() und setMethod() Methoden gemacht werden:

<?php
$form->setAction('/resource/process')
     ->setMethod('post');
?>

Der obige Code setzt die Form Aktion zu der partiellen URL "/resource/process" und die Form Methode zu HTTP POST. Das wird wärend der endgültigen Darstellung berücksichtigt.

Man kann zusätzliche HTML Attribute für das <form> Tag setzen indem die setAttrib() oder setAttribs() MEthoden verwendet werden. Zum Beispiel wenn man die ID setzen will, setzt man das "id" Attribut:

<?php
$form->setAttrib('id', 'login');
?>

Eine Form ist nichts ohne Ihre Elemente. Zend_Form kommt mit einigen Standardelementen die XHTML über Zend_View Helfer darstellen. Das sind die folgenden:

• button

• checkbox (oder viele Checkboxen auf einmal mit multiCheckbox)

• hidden

• image

• password

• radio

• reset

• select (beide, normale und mehrfach-select Typen)

• submit

• text

• textarea

Es gibt zwei Optionen für das Hinzufügen von Elementen zu einer form: Man kann ein konkretes Element instanziieren und dieses dem Objekt übergeben, oder man kann einfach den Typ des Elements übergeben und Zend_Form ein Objekt des richtigen Typs für einen Instanziieren lassen.

Einige Beispiele:

<?php
// Ein Element instanziieren und an das Form Objekt übergeben:
$form->addElement(new Zend_Form_Element_Text('username'));

// Den Fyp des Form Elements dem Form Objekt übergeben:
$form->addElement('text', 'username');
?>

Standardmäßig haben diese keine Prüfer oder Filter. Das bedeutet das man eigene Elemente mit minimalen Prüfern und potentiellen Filtern konfigurieren muß. Man kann das entweder (a) vor der Übergabe des Elements an die Form machen, (b) über Konfigurationsoptionen die bei der Erstellung des Elements über Zend_Form angegeben werden, oder (c) durch ziehen des Elements vom Form Objekt und dessen Konfiguration im Nachhinein.

Betrachten wir zuerst die Erstellung eines Prüfers für eine konkrete Instanz eines Elements. Es können entweder Zend_Validate_* Instanzen übergeben werden, oder der Name des Prüfers der verwendet werden soll:

<?php
$username = new Zend_Form_Element_Text('username');

// Ein Zend_Validate_* Objekt übergeben:
$username->addValidator(new Zend_Validate_Alnum());

// Den Namen des Prüfers übergeben:
$username->addValidator('alnum');
?>

Wenn die zweite Option verwendet wird kann, wenn der Prüfer Argumente im Konstruktor akzeptiert, diesem ein Array als dritter Parameter übergeben werden:

<?php
// Ein Pattern übergeben
$username->addValidator('regex', false, array('/^[a-z]/i'));
?>

(Der zweite Parameter wird verwendet um anzuzeigen ob spätere Prüfer bei einem Fehler dieses Prüfers ausgeführt werden sollen oder nicht; standardmäßig ist er false.)

Es kann auch gewünscht sein ein Element als benötigt zu spezifizieren. Das kann durch Verwendung eines Accessors getan werden oder durch die Übergabe einer Option bei der Erstellung des Elemetns. Im ersteren Fall:

<?php
// Dieses Element als benötigt definieren:
$username->setRequired(true);
?>

Wenn ein Element benöigt wird, wird ein 'NotEmpty' Prüfer ganz oben in der Prüfkette definiert, um sicherzustellen das dieses Element einen Wert hat wenn er benötigt wird.

Filter werden grundsätzlich auf dem gleichen Weg wie die Prüfer definiert. Zu Anschauungszwecken, wird ein Filter hinzugefügt der den endgültigen Wert klein schreibt:

<?php
$username->addFilter('StringtoLower');
?>

Das endgültige Setup des Elements könnte also wie folgt aussehen:

<?php
$username->addValidator('alnum')
         ->addValidator('regex', false, array('/^[a-z]/'))
         ->setRequired(true)
         ->addFilter('StringToLower');

// oder kompakter:
$username->addValidators(array('alnum',
        array('regex', false, '/^[a-z]/i')
    ))
    ->setRequired(true)
    ->addFilters(array('StringToLower'));
?>

So einfach das ist, ist das für jedes einzelne Elemet in einer Form sehr aufwendig. Versuchen wir es also mit Option (b) von oben. Wenn wir ein neues Element erstellen wird Zend_Form::addElement() als Factory verwendet, und wir können optional Konfigurationsoptionen übergeben. Diese können Prüfer und Filter enthalten die angepasst werden können. Um also alles von oben implizit durchzuführen, versuchen wir folgendes:

<?php
$form->addElement('text', 'username', array(
    'validators' => array(
        'alnum',
        array('regex', false, '/^[a-z]/i')
    ),
    'required' => true,
    'filters'  => array('StringToLower'),
));
?>

Hinweis: Wenn man sieht das man Elemente konfiguriert die die gleichen Optionen in vielen Plätzen verwenden, kann es gewünscht sein eine eigene Zend_Form_Element Subklasse zu erstellen und diese Klasse stattdessen anzupassen; das spart viel Tipparbeit im weiteren Verlauf.

Die Darstellung einer Form ist einfach. Die meisten Elemente verwendetn einen Zend_View Helfer um sich selbst darzustellen, und benötigen deshalb ein View Objekt um dargestellt zu werden. Anders als das, gibt es zwei Optionen: Die render() Methode der Form verwenden, oder einfaches echo.

<?php
// Explizit render() ausrufen und ein optionales View Objekt übergeben:
echo $form->render($view);

// Angenommen ein View Objekt wurde vorher über setView() gesetzt:
echo $form;
?>

Standardmäßig versuchen Zend_Form und Zend_Form_Element ein im ViewRenderer initialisiertes View Objekt zu verwenden, was bedeutet das die View nicht manuell gesetzt werden muß wenn das Zend Framework MVC verwendet wird. Die Darstellung einer Form in einem View Skript ist so einfach wie:

<?= $this->form ?>

Unter der Hand verwendet Zend_Form "Dekorators" um die Darstellung durchzuführen. Diese Dekoratore können Inhalte ersetzen, Inhalte anfügen oder Inhalte voranstellen, und haben eine volle Introspektive des Elements das Ihnen übergeben wurde. Als Ergebnis, können mehrere Dekoratore kombiniert werden um eigene Effekte zu ermöglichen. Standardmüßig kombiniert Zend_Form_Element View Dekoratore um seine Ausgaben zu erstellen; das Setup sieht ähnlich diesem aus:

<?php
$element->addDecorators(array(
    'ViewHelper',
    'Errors',
    array('HtmlTag', array('tag' => 'dd')),
    array('Label', array('tag' => 'dt')),
));
?>

(Wobei <HELPERNAME> der Name des View Helfers ist der verwendet wird, und variiert basierend auf dem Element.)

Das obige erstellt eine Ausgabe ähnlich der folgenden:

<dt><label for="username" class="required">Username</dt>
<dd>
    <input type="text" name="username" value="123-abc" />
    <ul class="errors">
        <li>'123-abc' has not only alphabetic and digit characters</li>
        <li>'123-abc' does not match against pattern '/^[a-z]/i'</li>
    </ul>
</dd>

(Wenngleich nicht mit der gleichen Formatierung.)

Die Dekoratore die von einem Element verwendet werden können geändert werden um eine andere Ausgabe zu erzeugen; diese das Kapitel über Dekoratore für mehr Informationen.

Die Form selbst geht einfach alle Elemente durch, und fügt diese in eine HTML <form> ein. Die Aktion und Methode die bei der Erstellung der Form angegeben wurden werden dem <form> Tag angegeben, wie wenn Sie Attribute wären die über setAttribs() und ähnliche gesetzt werden.

Elemente werden entweder in der Reihenfolge in der Sie registriert wurden durchlaufen, oder, wenn ein Element ein order Attribut enthält, in dieser Reihenfolge. Die Reihenfolge eines Elements kann wie folgt gesetzt werden:

<?php
$element->setOrder(10);
?>

Oder bei der Erstellung des Elements durch Übergabe als Option:

<?php
$form->addElement('text', 'username', array('order' => 10));
?>

Nachdem eine Form übermittelt wurde, muss diese geprüft werden um zu sehen ob Sie alle Prüfungen besteht. Jedes Element wird gegen die angegebenen Daten geprüft; wenn ein Schlüssel der dem Elementnamen entspricht nicht vorhanden ist, und das Teil als benötigt markiert ist, werden die Prüfungen mit einem null Wert ausgeführt.

Wo kommen die Daten her? Man kann $_POST oder $_GET verwenden, oder jede andere Datenquelle die man bei der Hand hat (Web Service Anfragen zum Beispiel):

<?php
if ($form->isValid($_POST)) {
    // erfolgreich!
} else {
    // fehlgeschlagen!
}
?>

Mit AJAX Anfragen kann man manchmal davon abgehen einzelne Elemente oder Gruppen von Elementen zu prüfen. isValidPartial() prüft eine Teilform. Anders als isValid() werden, wenn ein spezieller Schlüssel nicht vorhanden ist, Prüfungen für dieses spezielle Element nicht durchgeführt:

<?php
if ($form->isValidPartial($_POST)) {
    // Elemente hat alle Prüfungen bestanden
} else {
    // Ein oder mehrere getestete Elemente haben die Prüfung nicht bestanden
}
?>

Eine zusätzliche Methode, processAjax(), kann auch dafür verwendet werden um Teilformen zu prüfen. Anders als isValidPartial() gibt Sie einen JSON-formatierten String zurück der bei einem Fehler die Fehlermeldungen enthält.

Angenommen die Prüfungen sind durchgeführt worden, dann können jetzt die gefilterten Werte geholt werden:

<?php
$values = $form->getValues();
?>

Wenn an irgendeinem Punkt die ungefilterten Werte benötigt werden kann man folgendes verwenden:

<?php
$unfiltered = $form->getUnfilteredValues();
?>

So, die Form hat also die Prüfungen nicht bestanden? In den meisten Fällen kann die Form einfach neu dargestellt werden, und Fehler werden angezeigt wenn Standardekoratore verwendet werden:

<?php
if (!$form->isValid($_POST)) {
    echo $form;

    // oder dem View Obejekt zuordnen und eine View darstellen...
    $this->view->form = $form;
    return $this->render('form');
}
?>

Wenn die Fehler inspiziert werden sollen gibt es zwei Methoden. getErrors() gibt ein assoziatives Array von Elementnamen / Codes zurück (wobei Codes ein Array von Fehlercodes ist). getMessages() gibt ein assoziatives Array von Elementnamen / Nachrichten zurück (wobei Nachrichten ein assoziatives Array von Fehlercodes / Fehlernachrichten Paaren ist). Wenn ein gegebenes Element keinen Fehler hat, wird es nicht im Array inkludiert.

Bauen wir also ein einfaches Login Form. Es benötigt Elemente die folgendes repräsentieren:

• username

• password

• submit

Für unsere Zwecke nehmen wir an das ein gültiger Benutzername nur alphanumerische Zeichen enthalten soll mit einem Buchstaben beginnt, eine Mindestlänge von 6 und eine Maximallänge von 20 hat; er wird zu Kleinschreibung normalisiert. Passwörter müssen mindestens 6 Zeichen lang sein. Der submit Wert wird einfach ignoriert wenn wir fertig sind, er kann also ungeprüft bleiben.

Wir verwenden die Stärke von Zend_Form's Konfigurationsoptionen um die Form zu erstellen:

<?php


$form = new Zend_Form();
$form->setAction('/usr/login')
     ->setMethod('post');

// Ein username Element erstellen und konfigurieren:
$username = $form->createElement('text', 'username');
$username->addValidator('alnum')
         ->addValidator('regex', false, array('/^[a-z]+/'))
         ->addValidator('stringLength', false, array(6, 20))
         ->setRequired(true)
         ->addFilter('StringToLower');

// Ein Passwort Element erstellen und konfigurieren:
$password = $form->createElement('password', 'password');
$password->addValidator('StringLength', false, array(6))
         ->setRequired(true);

// Elemente der Form hinzufügen:
$form->addElement($username)
     ->addElement($password)
     // addElement() als Factory verwenden um den 'Login' Button zu erstellen:
     ->addElement('submit', 'login', array('label' => 'Login'));
?>

Als nächstes wird ein Controller erstellt der das behandelt:

<?php
class UserController extends Zend_Controller_Action
{
    public function getForm()
    {
        // Form wie oben erstellen
        return $form;
    }

    public function indexAction()
    {
        // user/form.phtml darstellen
        $this->view->form = $this->getForm();
        $this->render('form');
    }

    public function loginAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->_forward('index');
        }
        $form = $this->getForm();
        if (!$form->isValid($_POST)) {
            // Fehlgeschlagene Prüfung; Form wieder anzeigen
            $this->view->form = $form;
            return $this->render('form');
        }
        
        $values = $form->getValues();
        // Jetzt versuchen zu Authentifizieren...
    }
}
?>

Und ein View Skript für die Darstellung der Form:

<h2>Bitte anmelden:</h2>
<?= $this->form ?>

Wie man im Controller Code sieht, gibt es mehr Arbeit zu tun: Wärend die Übertragung gültig sein muß, kann es trotzdem notwendig sein, zum Beispiel, Authentifizierung mit Hilfe von Zend_Auth durchzuführen.

Alle Zend_Form sind konfigurierbar indem Zend_Config verwendet wird; es kann entweder ein Zend_Config Objekt an den Kontruktor oder es kann über setConfig() übergeben werden. Sehen wir uns an wie die obige Form erstellt werden können indem eine INI Datei verwendet wird. Zuerst folgen wir den Notwendigkeiten und platzieren die Konfigurationen in Sektionen die den Ort des Releases reflektieren, und fokusieren auf die 'development' Sektion. Als nächstes wird eine Sektion für den gegebenen Controller ('user') definiert und ein Schlüssel für die Form ('login'):

[development]
; general form metainformation
user.login.action = "/user/login"
user.login.method = "post"

; username element
user.login.elements.username.type = "text"
user.login.elements.username.options.validators.alnum.validator = "alnum"
user.login.elements.username.options.validators.regex.validator = "regex"
user.login.elements.username.options.validators.regex.options.pattern = "/^[a-z]/i"
user.login.elements.username.options.validators.strlen.validator = "StringLength"
user.login.elements.username.options.validators.strlen.options.min = "6"
user.login.elements.username.options.validators.strlen.options.max = "20"
user.login.elements.username.options.required = true
user.login.elements.username.options.filters.lower.filter = "StringToLower"

; password element
user.login.elements.password.type = "password"
user.login.elements.password.options.validators.strlen.validator = "StringLength"
user.login.elements.password.options.validators.strlen.options.min = "6"
user.login.elements.password.options.required = true

; submit element
user.login.elements.submit.type = "submit"

Das kann dann an den Contruktor der Form übergeben werden:

<?php
$config = new Zend_Config_Ini($configFile, 'development');
$form   = new Zend_Form($config->user->login);
?>

und die komplette Form wird definiert werden.

Hoffentlich ist mit diesem kleinen Tutorial jetzt der Weg klar um die Leistung und Flexibilität von Zend_Form einzusetzen. Für detailiertere Informationen lesen Sie weiter!