Einführung

Die Komponente Zend_Validate bietet ein Reihe von häufig benötigten Prüfungen. Sie bietet auch einen einfachen Verkettungsmechanismus für Prüfungen, mit welchem mehrfache Prüfungen in einer benutzerdefinierten Reihenfolge auf einen einzelnen Wert angewendet werden können.

Was ist eine Prüfung?

Eine Prüfung untersucht ihre Eingabe hinsichtlich einiger Anforderungen und produziert ein boolesches Ergebnis - wenn die Eingabe erfolgreich gegen die Anforderungen geprüft werden konnte. Wenn die Eingabe den Anforderungen nicht entspricht, kann die Prüfung zusätzliche Informationen darüber bieten, welche der Anforderungen die Eingabe nicht entspricht.

Zum Beispiel könnte eine Webanwendung erfordern, dass ein Benutzername zwischen sechs und zwölf Zeichen lang sein soll und nur alphanumerische Zeichen enthalten soll. Eine Prüfung kann dafür verwendet werden um sicherzustellen, dass Benutzernamen diesen Anforderungen entsprechen. Wenn ein gewählter Benutzername einer oder beiden Anforderungen nicht entspricht, wäre es nützlich zu wissen, welche der Anforderungen der Benutzername nicht entsprochen hat.

Standardnutzung von Prüfungen

Prüfungen auf diesem Weg definiert zu haben, bietet die Grundlage für Zend_Validate_Interface, welche zwei Methoden definiert, isValid() und getMessages(). Die Methode isValid() führt eine Prüfung über die angegebenen Werte aus und gibt nur dann TRUE zurück, wenn der Wert gegenüber den Kriterien der Prüfung entsprochen hat.

Wenn isValid() FALSE zurück gibt, bietet getMessages() ein Array von Nachrichten, welches die Gründe für die fehlgeschlagene Prüfung beschreiben. Die Arrayschlüssel sind kurze Strings, welche die Gründe für eine fehlgeschlagene Prüfung identifizieren und die Arraywerte sind die entsprechend menschenlesbaren String-Nachrichten. Die Schlüssel und Werte sind klassenabhängig; jede Prüfklasse definiert ihr eigenes Set von Nachrichten für fehlgeschlagene Prüfungen und die eindeutigen Schlüssel, welche diese identifizieren. Jede Klasse hat also eine const Definition die jedem Identifikator für eine fehlgeschlagene Prüfung entspricht.

Note: Die Methode getMessages() gibt die Information für Prüfungsfehler nur für den zuletzt durchgeführten Aufruf von isValid() zurück. Jeder Aufruf von isValid() löscht jegliche Nachricht und Fehler, welche durch vorhergehende Aufrufe von isValid() vorhanden waren, weil normalerweise jeder Aufruf von isValid() für einen unterschiedlichen Eingabewert gemacht wird.

Das folgende Beispiel zeigt die Prüfung einer E-Mail Adresse:

  1. $validator = new Zend_Validate_EmailAddress();
  2.  
  3. if ($validator->isValid($email)) {
  4.     //
  5.     // E-Mail scheint gültig zu sein
  6.     //
  7. } else {
  8.     //
  9.     // E-Mail ist ungültig; drucke die Gründe
  10.     //
  11.     foreach ($validator->getMessages() as $messageId => $message) {
  12.         echo "Validation failure '$messageId': $message\n";
  13.     }
  14. }

Nachrichten anpassen

Prüfklassen bieten eine Methode setMessage(), mit der das Format der Nachricht definiert werden kann, die von getMessages() im Fall einer fehlerhaften Prüfung zurückgegeben wird. Das erste Argument dieser Methode ist ein String, der die Fehlernachricht enthält. Es können Kürzel in den String eingebaut werden, welche mit den für die Prüfung relevanten Daten aufgefüllt werden. Das Kürzel %value% wird von allen Prüfungen unterstützt; es ist verbunden mit dem Wert der an isValid() übergeben wird. Andere Kürzel können in jeder Prüfklasse von Fall zu Fall unterstützt werden. Zum Beispiel ist %max% das Kürzel, welches von Zend_Validate_LessThan unterstützt wird. Die getMessageVariables() Methode gibt ein Array von variablen Kürzeln zurück, welche vom Prüfer unterstützt werden.

Das zweite optionale Argument ist ein String, der das Template der fehlerhaften Prüfnachricht identifiziert, die gesetzt werden soll. Das ist nützlich wenn eine Prüfklasse mehr als einen Grund für einen Fehlschlag definiert. Wenn das zweite Argument nicht angegeben wird, nimmt setMessage() an, dass die spezifizierte Nachricht für das erste Messagetemplate verwendet werden soll, das in der Prüfklasse definiert ist. Viele Prüfklassen haben nur ein Template für eine Fehlernachricht definiert, sodass es nicht notwendig ist anzugeben, welches Template für Fehlernachrichten geändert werden soll.

  1. $validator = new Zend_Validate_StringLength(8);
  2.  
  3. $validator->setMessage(
  4.     'Der String \'%value%\' ist zu kurz; er muss mindestens %min% ' .
  5.     'Zeichen sein',
  6.     Zend_Validate_StringLength::TOO_SHORT);
  7.  
  8. if (!$validator->isValid('word')) {
  9.     $messages = $validator->getMessages();
  10.     echo $messages[0];
  11.  
  12.     // "Der String 'word' ist zu kurz; er muss mindestens 8 Zeichen sein"
  13. }

Es können mehrere Nachrichten durch Verwendung der Methode setMessages() gesetzt werden. Dessen Argument ist ein Array, welches Schlüssel/Nachrichten Paare enthält.

  1. $validator = new Zend_Validate_StringLength(array('min' => 8, 'max' => 12));
  2.  
  3. $validator->setMessages( array(
  4.     Zend_Validate_StringLength::TOO_SHORT =>
  5.         'Der String \'%value%\' ist zu kurz',
  6.     Zend_Validate_StringLength::TOO_LONG  =>
  7.         'Der String \'%value%\' ist zu lang'
  8. ));

Wenn die Anwendung mehr Flexibilität benötigt in der Art und Weise wie Prüffehler gemeldet werden, kann auf die Eigenschaften durch denselben Namen zugegriffen werden, wie mit dem Nachrichtenkürzel, das von einer Prüfklasse unterstützt wird. Die Eigenschaft value ist immer in einem Prüfer vorhanden; Das ist der Wert, der als Argument von isValid() definiert wurde. Andere Eigenschaften können von Fall zu Fall in jeder Prüfklasse unterstützt werden.

  1. $validator = new Zend_Validate_StringLength(array('min' => 8, 'max' => 12));
  2.  
  3. if (!validator->isValid('word')) {
  4.     echo 'Wort fehlgeschlaten: '
  5.         . $validator->value
  6.         . '; die Länge ist nicht zwischen '
  7.         . $validator->min
  8.         . ' und '
  9.         . $validator->max
  10.         . "\n";
  11. }

Verwenden der statischen is() Methode

Wenn es unpassend ist, eine gegebenen Prüfklasse zu laden und eine Instanz des Prüfers zu erstellen, kann die statische Methode Zend_Validate::is() als alternativer Stil des Aufrufs verwendet werden. Das erste Argument dieser Methode ist ein Datenwert, der an die Methode isValid() übergeben werden würde. Das zweite Argument ist ein String, welcher mit dem Basisnamen der Prüfklasse übereinstimmt, relativ zum Namensraum von Zend_Validate. Die Methode is() lädt die Klasse automatisch, erstellt eine Instanz und wendet die Methode isValid() auf die Eingabedaten an.

  1. if (Zend_Validate::is($email, 'EmailAddress')) {
  2.     // Ja, die Email Adresse scheint gültig zu sein
  3. }

Es kann auch ein Array von Konstruktor-Argumenten übergeben werden, wenn diese für die Prüfung benötigt werden.

  1. if (Zend_Validate::is($value, 'Between', array('min' => 1, 'max' => 12))) {
  2.     // Ja, $value ist zwischen 1 und 12
  3. }

Die Methode is() gibt einen booleschen Wert zurück, denselben wie die Methode isValid(). Wird die statische Methode is() verwendet, sind Nachrichten für Prüffehler nicht vorhanden.

Die statische Verwendung kann für das ad hoc Verwenden eines Prüfers bequem sein, aber wenn ein Prüfer für mehrere Eingaben verwendet werden soll, ist es effizienter die nicht statische Verwendung zu benutzen, indem eine Instanz des Prüfobjekts erstellt wird und dessen Methode isValid() aufgerufen wird.

Die Klasse Zend_Filter_Input erlaubt es, auch mehrfache Filter und Prüfklassen zu instanzieren und bei Bedarf aufzurufen, um Sets von Eingabedaten zu bearbeiten. Siehe Zend_Filter_Input.

Namespaces

Wenn man mit selbst definierten Prüfungen arbeitet, dann kann man an Zend_Validate::is() einen vierten Parameter übergeben welcher der Namespace ist, an dem die eigene Prüfung gefunden werden kann.

  1. if (Zend_Validate::is($value, 'MyValidator', array('min' => 1, 'max' => 12),
  2.                       array('FirstNamespace', 'SecondNamespace')) {
  3.     // Ja, $value ist in Ordnung
  4. }

Zend_Validate erlaubt es auch, standardmäßige Namespaces zu setzen. Das bedeutet, dass man sie einmal in der Bootstrap setzt und sie nicht mehr bei jedem Aufruf von Zend_Validate::is() angeben muss. Der folgende Codeschnipsel ist identisch mit dem vorherigen.

  1. Zend_Validate::setDefaultNamespaces(array('FirstNamespace', 'SecondNamespace'));
  2. if (Zend_Validate::is($value, 'MyValidator', array('min' => 1, 'max' => 12)) {
  3.     // Yes, $value is ok
  4. }
  5.  
  6. if (Zend_Validate::is($value,
  7.                       'OtherValidator',
  8.                       array('min' => 1, 'max' => 12)) {
  9.     // Yes, $value is ok
  10. }

Der Bequemlichkeit halber gibt es die folgenden Methoden, welche die Behandlung von Namespaces erlauben:

  • Zend_Validate::getDefaultNamespaces(): Gibt alle standardmäßigen Namespaces als Array zurück.

  • Zend_Validate::setDefaultNamespaces(): Setzt neue standardmäßige Namespaces und überschreibt alle vorher gesetzten. Es wird entweder ein String für einen einzelnen Namespace akzeptiert oder ein Array für mehrere Namespaces.

  • Zend_Validate::addDefaultNamespaces(): Fügt zusätzliche Namespaces zu den bereits gesetzten hinzu. Es wird entweder ein String für einen einzelnen Namespace akzeptiert oder ein Array für mehrere Namespaces.

  • Zend_Validate::hasDefaultNamespaces(): Gibt TRUE zurück, wenn ein oder mehrere standardmäßige Namespaces gesetzt sind und FALSE, wenn keine standardmäßigen Namespaces gesetzt sind.

Meldungen übersetzen

Prüfungsklassen bieten eine Methode setTranslator(), mit der man eine Instanz von Zend_Translate definieren kann, die Nachrichten im Falle eines Prüfungsfehlers übersetzt. Die getTranslator() Methode gibt die gesetzte Übersetzungsinstanz zurück.

  1. $validator = new Zend_Validate_StringLength(array('min' => 8, 'max' => 12));
  2. $translate = new Zend_Translate(
  3.     array(
  4.         'adapter' => 'array',
  5.         'content' => array(
  6.             Zend_Validate_StringLength::TOO_SHORT => 'Übersetzt \'%value%\''
  7.         ),
  8.         'locale'  => 'en'
  9.     )
  10. );
  11.  
  12. $validator->setTranslator($translate);

Mit der statischen Methode setDefaultTranslator() kann eine Instanz von Zend_Translate gesetzt werden und mit getDefaultTranslator() empfangen. Das verhindert, dass man den Übersetzer manuell für alle Prüfungsklassen setzen muss und vereinfacht den Code.

  1. $translate = new Zend_Translate(
  2.     array(
  3.         'adapter' => 'array',
  4.         'content' => array(
  5.             Zend_Validate_StringLength::TOO_SHORT => 'Übersetzt \'%value%\''
  6.         ),
  7.         'locale'  => 'en'
  8.     )
  9. );
  10. Zend_Validate::setDefaultTranslator($translate);

Note: Wenn man ein anwendungsweites Gebietsschema in der Registry gesetzt hat, wird dieses Gebietsschema als standardmäßiger Übersetzer verwendet.

Manchmal ist es notwendig, den Übersetzer in einer Prüfklasse auszuschalten. Um das zu tun, kann die Methode setDisableTranslator() verwendet werden, welche einen booleschen Wert akzeptiert und translatorIsDisabled(), um den gesetzten Wert zu erhalten.

  1. $validator = new Zend_Validate_StringLength(array('min' => 8, 'max' => 12));
  2. if (!$validator->isTranslatorDisabled()) {
  3.     $validator->setDisableTranslator();
  4. }

Es ist auch möglich einen Übersetzer zu verwenden, statt eigene Meldungen mit setMessage() zu setzen. Aber wenn man das tut, sollte man im Kopf behalten, dass der Übersetzer auch mit den Meldungen arbeitet, die man selbst gesetzt hat.

blog comments powered by Disqus