Wenn alle Eingabedaten die Prüfregeln bestanden haben, gibt die isValid() Methode TRUE zurück. Wenn irgendein Feld ungültig ist oder ein benötigtes Feld fehlt, gibt die isValid() Methode FALSE zurück.

if ($input->isValid()) {
  echo "OK\n";
}

Diese Methode akzeptiert ein optionales String Argument, das ein individuelles Feld benennt. Wenn das spezifizierte Feld die Prüfung passiert und bereit ist um abgeholt zu werden, gibt isValid('fieldName') den Wert TRUE zurück.

if ($input->isValid('month')) {
  echo "Feld 'month' ist OK\n";
}

if ($input->hasInvalid() || $input->hasMissing()) {
  $messages = $input->getMessages();
}

// getMessages() gibt einfach die Zusammenfassung von getInvalid()
// und getMissing() zurück

if ($input->hasInvalid()) {
  $invalidFields = $input->getInvalid();
}

if ($input->hasMissing()) {
  $missingFields = $input->getMissing();
}

if ($input->hasUnknown()) {
  $unknownFields = $input->getUnknown();
}

Das Ergebnis der getMessages() Methode ist ein assoziatives Array, das die Regelnamen einem Array von Fehlermeldungen, relativ zu diesen Regeln, zuordnet. Es ist anzumerken das der Index dieses Arrays der Name der Regel ist die in der Regeldeklaration verwendet wird, und welche von den Namen der Felder, die von der Regel geprüft werden, unterschiedlich sein kann.

Die getMessages() Methode gibt eine Zusammenfassung der Arrays zurück die von getInvalid() und getMissing() retourniert werden. Diese Methoden geben Subsets der Nachrichten zurück, relativ zu den Prüffehlern, oder Felder die als benötigt deklariert wurden aber in der Eingabe fehlen.

Die getErrors() Methode gibt ein assoziatives Array zurück, in dem die Regelnamen einem Array von Fehler Identifizierern entsprechen. Fehler Identifizierer sind fixe Strings, um Gründe für eine fehlgeschlagene Prüfung, zu identifizieren, wobei Nachrichten selbst geändert werden können. Siehe dieses Kapitel für mehr Informationen.

Die Nachricht die von getMissing() zurückgegeben wird kann als Argument beim Zend_Filter_Input Konstruktor, oder durch verwenden der setOptions() Methode, spezifiziert werden.

$options = array(
    'missingMessage' => "Feld '%field%' wird benötigt"
);

$input = new Zend_Filter_Input($filters, $validators, $data, $options);

// alternative Methode:

$input = new Zend_Filter_Input($filters, $validators, $data);
$input->setOptions($options);

Und man kann auch einen Übersetzer hinzufügen der einem die Möglichkeit bietet mehrere Sprachen für die Meldungen anzubieten welche von Zend_Filter_Input zurückgegeben werden.

$translate = new Zend_Translate_Adapter_Array(array(
    'content' => array(
        Zend_Filter_Input::MISSING_MESSAGE => "Wo ist das Feld?"
    )
);

$input = new Zend_Filter_Input($filters, $validators, $data);
$input->setTranslator($translate);

Wenn man einen anwendungsweiten Übersetzer verwendet, dann wird dieser von Zend_Filter_Input verwendet. In diesem Fall muss man den Übersetzer nicht manuell setzen.

Das Ergebnis der getUnknown() Methode ist ein assoziatives Array, in dem die Feldnamen den Feldwerten zugeordnet werden. Feldnamen werden in diesem Fall als Arrayschlüssel verwendet, statt als Regelnamen, weil keine Regel die Feld erwähnt die unbekannte Felder sind.

Alle Felder die entweder ungültig, fehlend oder unbekannt sind, werden als gültig angenommen. Man kann Werte für diese Felder erhalten indem ein magischer Accessor verwendet wird. Es gibt auch die nicht-magische Accessor Methoden getEscaped() und getUnescaped().

$m = $input->month;                 // Ausgabe vom magischen Accessor kommentieren
$m = $input->getEscaped('month');   // Ausgabe kommentieren
$m = $input->getUnescaped('month'); // nicht kommentieren

Standardmäßig, wenn ein Wert empfangen wird, wird er mit Zend_Filter_HtmlEntities gefiltert. Das ist der Standard weil angenommen wird, das die am meisten übliche Verwendung, die Ausgabe von Werten von einem Feld in HTML ist. Der HtmlEntities Filter hilft ungewollten Ausgaben von Code vorzubeugen, welche zu Sicherheitsproblemen führen könnten.

$validators = array('*' => array());

$input = new Zend_Filter_Input($filters, $validators, $data, $options);

Es kann ein anderer Filter für das auskommentieren von Werten definiert werden, durch seine Spezifikation im Array der Optionen des Konstruktors:

$options = array('escapeFilter' => 'StringTrim');
$input = new Zend_Filter_Input($filters, $validators, $data, $options);

Alternativ kann die setDefaultEscapeFilter() Methode verwendet werden:

$input = new Zend_Filter_Input($filters, $validators, $data);
$input->setDefaultEscapeFilter(new Zend_Filter_StringTrim());

Bei jeder Verwendung, kann der Kommentarfilter als String Basisname der Filterklasse, oder als Objektinstanz einer Filterklasse, spezifiziert werden. Der Kommentarfilter kann eine Instanz einer Filterkette, oder ein Objekt der Zend_Filter Klasse sein.

Filter die Ausgaben kommentieren sollen auf diesen Weg ausgeführt werden, um sicherzustellen das Sie nach der Prüfung ausgeführt werden. Andere Filter, die im Array der Filterregeln deklariert werden, werden bei den Eingabedaten angewendet bevor diese Daten geprüft werden. Wenn Kommentarfilter vor der Prüfung ausgeführt werden, würde der Prozess der Prüfung viel komplexer sein um sowohl kommentierte als auch unkommentierte Versionen der Daten anzubieten. Deswegen wird empfohlen, Filter die Ausgaben mit setDefaultEscapeFilter() kommentieren, nicht im $filters Array zu deklarieren.

Es gibt nur eine getEscaped() Methode, und deswegen kann nur ein Filter für das kommentieren spezifiziert werden (trotzdem kann dieser Filter eine Filterkette sein). Wenn eine einzelne Instanz von Zend_Filter_Input benötigt wird, um kommentierte Ausgaben zu erhalten, und mehr als eine Filtermethode angewendet werden soll, sollte Zend_Filter_Input erweitert werden und neue Methoden in der Subklasse implementiert werden um Wert auf unterschiedlichen Wegen zu erhalten.

Wenn der Name der Regel für einen Filter oder Prüfer anders lautet als das Feld in welchem er angewendet werden soll, kann der Feldname mit dem 'fields' Metakommando spezifiziert werden.

Dieses Metakommando kann durch Verwendung der Klassenkonstanten Zend_Filter_Input::FIELDS statt der Angabe eines Strings spezifiziert werden.

$filters = array(
    'month' => array(
        'Digits',        // Namen als Integer Index [0] filtern
        'fields' => 'mo' // Namen als String Index ['fields'] filtern
    )
);

Im obigen Beispiel wendet die Filterregel den 'digits' Filter am Eingabefeld, das 'mo' heißt, an. Der String 'month' wird einfach ein mnemonischer Schlüsselfür diese Filterregel; er wird nicht als Filtername verwendet wenn der Filter mit dem 'fields' Metakommando spezifiziert wird, aber er wird als Regelname verwendet.

Der Standardwert des 'fields' Metakommandos ist der Index der aktuellen Regel. Im obigen Beispiel wird die Regel, wenn das 'fields' Metakommando nicht spezifiziert wird, auf das Eingabefeld das 'month' heißt, angewendet.

Eine weitere Verwendung des 'fields' Metakommandos ist es Felder für Filter oder Prüfer zu spezifizieren die mehrere Felder als Eingabe benötigen. Wenn das 'fields' Metakommando ein Array ist, ist das Argument des korrespondierenden Filters oder Prüfers ein Array mit den Werten dieser Felder. Zum Beispiel ist es für Benutzer üblich einen Passwort String in zwei Feldern zu spezifizieren, und diese müssen den selben String in beide Felder eingeben. Man kann zum Beispiel eine Prüfklasse implmentieren die ein Array Argument annimmt, und TRUE zurückgibt wenn alle Werte im Array identisch zum jeweils anderen sind.

$validators = array(
    'password' => array(
        'StringEquals',
        'fields' => array('password1', 'password2')
    )
);
//  Inkludiert die hypotetische Klasse Zend_Validate_StringEquals,
// übergibt dieser ein Array Argument das den Wert der beiden Eingabe
// Datenfelder enthält die 'password1' und 'password2' heißen.

Wenn die Prüfung dieser Regel fehlschlägt wird der Schlüssel der Regel ('password') im Rückgabewert von getInvalid() verwendet und nicht eine der benannten Felder im 'fields' Metakommando.

Jeder Eintrag im Prüfarray kann ein Metakommando haben das 'presence' heißt. Wenn der Wert dieses Metakommandos 'required' ist muß dieses Feld in den Eingabedaten existieren, andernfalls wird es als fehlendes Feld gemeldet.

Das Metakommando kann auch spezifiziert werden indem die Klassenkonstante Zend_Filter_Input::PRESENCE statt dem String verwendet wird.

$validators = array(
    'month' => array(
        'digits',
        'presence' => 'required'
    )
);

Der Standardwert dieses Metakommandos ist 'optional'.

Wenn ein Feld, für das ein Wert mit dem 'default' Metakommando für diese Regel, in den Eigabedaten vorhanden ist, nimmt das Feld den Wert dieses Metakommandos.

Dieses Metakommando kann auch spezifiziert werden indem die Klassenkonstante Zend_Filter_Input::DEFAULT_VALUE statt einem String verwendet wird.

Der Standardwert wird dem Feld zugeordnet bevor irgendeiner der Prüfungen stattfindet. Der Standardwert wird dem Feld nur für die aktuelle Regel zugeordnet; wenn das selbe Weld in einer folgenden Regel referenziert wird, hat dieses Feld keinen Wert wenn diese Regel evaluiert wird. Deshalb können verschiedene Regeln auch verschiedene Standardwerte für ein gegebenes Feld deklarieren.

$validators = array(
    'month' => array(
        'digits',
        'default' => '1'
    )
);

// kein Wert für das 'month' Feld
$data = array();

$input = new Zend_Filter_Input(null, $validators, $data);
echo $input->month; // gibt 1 aus

Wenn eine Regel das FIELDS Metakommando verwendet um ein Array mit mehrfachen Feldern zu definieren, kann ein Array für das DEFAULT_VALUE Metakommando definiert werden und der Standard der korrespondierenden Schlüssel wird für alle fehlenden Felder verwendet. Wenn FIELDS mehrfache Felder definiert aber DEFAULT_VALUE nur ein skalarer Wert ist, dann wird dieser Standardwert als Wert für alle fehlenden Feldern im Array verwendet.

Es gibt keinen Standardwert für dieses Metakommando.

Standardmäßig, wenn ein Feld in den Eingabedaten existiert, wird Ihm der Prüfer zugeordnet selbst wenn der Wert des Feldes ein leerer String ist (''). Das kann zu einem Fehler in der Prüfung führen. Zum Beispiel, wenn ein Prüfer auf Ziffern prüft und es keine gibt weil ein leerer String keine Zeichen hat, weil der Prüfer dann die Daten als fehlerhaft meldet.

Wenn, in eigenen Fällen, ein leerer String als gültig angenommen werden soll, kann das Metakommando 'allowEmpty' auf TRUE gesetzt werden. Dann passieren die Eingabedaten die Prüfung wenn sie in den Eingabedaten vorhanden sind, aber der Wert ein leerer String ist.

Dieses Metakommando kann spezifiziert werden indem die Klassenkonstante Zend_Filter_Input::ALLOW_EMPTY statt einem String verwendet wird.

$validators = array(
    'address2' => array(
        'Alnum',
        'allowEmpty' => true
    )
);

Der Standardwert dieses Metakommandos ist FALSE.

Im unüblichen Fall das eine Prüfregel mit keinem Prüfer definiert wird, aber das 'allowEmpty' Metakommando FALSE ist (was bedeutet, dass das Feld als ungültig angenommen wird wenn es leer ist), gibt Zend_Filter_Input eine Standard Fehlermeldung zurück die mit getMessages() empfangen werden kann. Diese Meldung kann spezifiziert werden indem die 'notEmptyMessage' als Argument für den Zend_Filter_Input Constructor verwendet wird oder indem die setOptions() Methode verwendet wird.

$options = array(
    'notEmptyMessage' => "Ein nicht-leerer Wert wird für das Feld '%field%' benötigt"
);

$input = new Zend_Filter_Input($filters, $validators, $data, $options);

// alternative Methode:

$input = new Zend_Filter_Input($filters, $validators, $data);
$input->setOptions($options);

Standardmäßig, wenn eine Regel mehr als einen Prüfer hat werden alle Prüfer auf die Eingabe angewendet, und die resultierende Nachricht enthält alle Fehlermeldungen die durch die Eingabe verursacht wurden.

Alternativ, wenn der Wert des 'breakChainOnFailure' Metakommandos TRUE ist, terminiert die Prüfkette nachdem der erste Prüfer fehlschlägt. Die Eingabedaten werden nicht gegen nachfolgende Prüfer in der Kette geprüft. Sie können also weitere Fehlschläge verursachen selbst wenn der eine, der gemeldet wurde, korrigiert wird.

Dieses Metakommando kann spezifiziert werden indem die Klassenkonstante Zend_Filter_Input::BREAK_CHAIN statt einem String verwendet wird.

$validators = array(
    'month' => array(
        'Digits',
        new Zend_Validate_Between(1,12),
        new Zend_Validate_GreaterThan(0),
        'breakChainOnFailure' => true
    )
);
$input = new Zend_Filter_Input(null, $validators);

Der Standardwert dieses Metakommandos ist FALSE.

Die Klasse der Prüfketten, Zend_Validate, ist flexibler was das Durchbrechen von ausgeführten Ketten betrifft als Zend_Filter_Input. Mit der ersten Klasse, kann eine Option gesetzt werden um die Kette, für jeden Prüfer in der Kette, bei Fehlern unabhängig von jedem anderen Prüfer abzubrechen. Mit der anderen Klasse wird der definierte Wert des 'breakChainOnFailure' Metakommandos für eine Regel, einheitlich für alle Regeln in der Regel, angewendet. Wenn eine flexiblere Verwendung benötigt wird, sollte die Prüfkette selbst erstellt werden und diese als Objekt in der Definition der Prüfregel verwendet werden:

// Prüfkette mit nicht einheitlichen breakChainOnFailure Attributen
// erstellen
$chain = new Zend_Validate();
$chain->addValidator(new Zend_Validate_Digits(), true);
$chain->addValidator(new Zend_Validate_Between(1,12), false);
$chain->addValidator(new Zend_Validate_GreaterThan(0), true);

// Prüfregeln deklarieren welche die oben definierte Kette verwenden
$validators = array(
    'month' => $chain
);
$input = new Zend_Filter_Input(null, $validators);

Man kann Fehlermeldungen für jeden Prüfer in einer Regel spezifizieren indem das 'messages' Metakommando verwendet wird. Der Wert dieses Metakommandos variiert, je nachdem ob man mehrere Prüfer in der Regel hat, oder ob man die Nachricht für eine spezielles Fehlerereignis in einem angegebenen Prüfer setzen will.

Dieses Metakommando kann spezifiziert werden indem die Klassenkonstante Zend_Filter_Input::MESSAGES statt einem String verwendet wird.

Anbei ist ein einfaches Beispiel wie eine Standard fehlermeldung für einen einzelnen Prüfer gesetzt wird.

$validators = array(
    'month' => array(
        'digits',
        'messages' => 'Ein Monat darf nur aus Ziffern bestehen'
    )
);

Wenn mehrere Prüfer vorhanden sind für die eine Fehlermeldung gesetzt werden soll, sollte ein Array für dem Wert des 'messages' Metakommandos verwendet werden.

Jedes Element dieses Array wird dem Prüfer an der gleichen Indexposition zugeordnet. Man kann eine Nachricht für die Prüfung an der Position n spezifizieren indem der Wert von n als Array Index verwendet wird. So kann einigen Prüfern erlaubt werden Ihre eigenen Standardnachrichten zu verwenden, während die Nachricht für einen nachfolgenden Prüfer in der Kette gesetzt wird.

$validators = array(
    'month' => array(
        'digits',
        new Zend_Validate_Between(1, 12),
        'messages' => array(
            // Standardnachricht für Prüfer [0] verwenden
            // Neue Nachricht für Prüfer [1] setzen
            1 => 'Der Wert für Monat muß zwischen 1 und 12 sein'
        )
    )
);

Wenn einer der Prüfer mehrere Fehlermeldungen besitzt, werden diese durch Nachrichten Schlüssel identifiziert. Es gibt verschiedene Schlüssel in jeder Prüfklasse, welche als Identifizierer für Fehlernachrichten fungieren, die die entsprechende Prüfklasse erstellen kann. Jede Prüfklasse definiert Konstanten für Ihre Nachrichtenschlüssel. Diese Schlüssel können im 'messages' Metakommando verwendet werden indem Sie als assoziatives Array übergeben werden statt als String.

$validators = array(
    'month' => array(
        'digits', new Zend_Validate_Between(1, 12),
        'messages' => array(
            'Ein Monat darf nur aus Ziffern bestehen',
            array(
                Zend_Validate_Between::NOT_BETWEEN =>
                    'Der Wert %value% vom Monat sollte zwischen ' .
                    '%min% und %max% sein',
                Zend_Validate_Between::NOT_BETWEEN_STRICT =>
                    'Der Wert %value% vom Monat darf nur zwischen ' .
                    '%min% und %max% sein'
            )
        )
    )
);

Es sollte für jede Prüfklasse in die Dokumentation gesehen werden, um zu wissen ob diese mehrere Fehlernachrichten hat, welche Schlüssel die Nachrichten haben und welche Token im Nachrichtentemplate verwendet werden können.

Wenn man nur eine Prüfung in der Prüfregel hat, oder aller verwendeten Prüfungen die gleiche Nachricht gesetzt haben, dann kann auf Sie ohne zusätzliche Erstellung eines Arrays referiert werden:

$validators = array(
    'month' => array(
        new Zend_Validate_Between(1, 12),
        'messages' => array(
                        Zend_Validate_Between::NOT_BETWEEN =>
                            'Month value %value% must be between ' .
                            '%min% and %max%',
                        Zend_Validate_Between::NOT_BETWEEN_STRICT =>
                            'Month value %value% must be strictly between ' .
                            '%min% and %max%'
        )
    )
);

Der Standardwert für die 'allowEmpty', 'breakChainOnFailure', und 'presence' Metakommandos kann für alle Regeln gesetzt werden indem das $options Argument für den Konstruktor von Zend_Filter_Input verwendet wird. Das erlaubt das Setzen des Standardwertes für alle Regeln, ohne dass das Metakommando für jede Regel gesetzt werden muß.

// Der Standard wird bei allen Feldern gesetzt und erlaubt einen leeren String.
$options = array('allowEmpty' => true);

// Diese Regeldefinition kann überschrieben werden, wenn ein Feld keinen leeren
// String akzeptieren soll
$validators = array(
    'month' => array(
        'Digits',
        'allowEmpty' => false
    )
);

$input = new Zend_Filter_Input($filters, $validators, $data, $options);

Die 'fields', 'messages', und 'default' Metakommandos können nicht mit dieser Technik gesetzt werden.