Die Verwendung von Prüfungen ist sehr einfach. Es gibt verschiedene Methoden für das Hinzufügen und Manipulieren von Prüfungen.

• addValidator($validator, $options = null, $files = null): Fügt die angegebene Prüfung zu den Prüfungsstapel hinzu (optional nur zu den Datei(en) die spezifiziert wurden). $validator kann entweder eine aktuelle Prüfinstanz sein, oder ein Kurzname der den Prüfungstyp spezifiziert (z.B. 'Count').

• addValidators(array $validators, $files = null): Fügt die angegebenen Prüfungen zum Prüfungsstapel hinzu. Jeder Eintrag kann entweder ein Prüfungstyp/-options Paar sein, oder ein Array mit dem Schlüssel 'validator' das die Prüfung spezifiziert (alle anderen Optionen werden als Optionen für die Instanzierung der Prüfung angenommen).

• setValidators(array $validators, $files = null): Überschreibt alle bestehenden Prüfungen mit den spezifizierten Prüfungen. Die Prüfungen sollten der Syntax folgen die für addValidators() definiert ist.

• hasValidator($name): Zeigt ob eine Prüfung registriert wurde.

• getValidator($name): Gibt eine vorher registrierte Prüfung zurück.

• getValidators($files = null): Gibt registrierte Prüfungen zurück; wenn $files übergeben wurde, werden die Prüfungen für die betreffende Datei oder das Set an Dateien zurückgegeben.

• removeValidator($name): Entfernt eine vorher registrierte Prüfung.

• clearValidators(): Löscht alle registrierten Prüfungen.

$upload = new Zend_File_Transfer();

// Setzt eine Dateigröße von 20000 Bytes
$upload->addValidator('Size', 20000);

// Setzt eine Dateigröße von mindestens 20 Bytes und maximal 20000 Bytes
$upload->addValidator('Size', array(20, 20000));

// Setzt eine Dateigröße von mindestens 20 Bytes und Maximal
// 20000 Bytes und eine Dateianzahl in einem Schritt
$upload->setValidators(array(
    'Size'  => array(20, 20000), 
    'Count' => array(1, 3),
));

            

$upload = new Zend_File_Transfer();

// Setzt die Dateigröße auf 20000 Bytes und limitiert Sie nur auf 'file2'
$upload->addValidator('Size', 20000, 'file2');

            

Generell sollte einfach die addValidators() Methode verwendet werden, welche mehrmals aufgerufen werden kann.

$upload = new Zend_File_Transfer();

// Setzt die Dateigröße auf 20000 Bytes
$upload->addValidator('Size', 20000)
       ->addValidator('Count', 2)
       ->addValidator('Filessize', 25000);

            

Hinweis: Es ist zu beachten das, auch wenn das mehrfache Setzen der gleichen Prüfung erlaubt ist, das zu Problemen führen kann wenn verschiedene Optionen für die gleiche Prüfung verwendet werden.

Die Count Prüfung checkt die Anzahl der Dateien die angegeben wurde. Sie unterstützt die folgenden Optionen:

• min: Setzt die minimale Anzahl der Dateien die übertragen wird.

  Hinweis: Achtung: Wenn diese Option verwendet wird, muß die minimale Anzahl an Dateien übergeben werden wenn die Prüfung das erste Mal aufgerufen wird; sonst wird ein Fehler zurückgegeben.
  

  Mit dieser Option kann die Mindestanzahl an Dateien definiert werden die man Empfangen sollte.

• max: Setzt die maximale Anzahl an Dateien die übertragen wird.

  Mit dieser Option kann die Anzahl der Dateien limitiert werden die man akzeptiert, aber genauso eine mögliche Attacke erkennen wenn mehr Dateien übertragen werden als im Formular definiert wurden.

Diese Prüfung kann mit beiden Optionen initiiert werden. Die erste Option ist min, die zweite Option ist max. Wenn nur eine Option angegeben wird, wird Sie als max verwendet. Es können aber auch die Methoden setMin() und setMax() verwendet werden um beide Optionen im Nachhinein zu setzen und getMin() und getMax() um die aktuell gesetzten Werte zu erhalten.

$upload = new Zend_File_Transfer();

// Die Anzahl der Dateien auf maximal 2 limitieren
$upload->addValidator('Count', 2);

// Die Anzahl der Datein auf Maximal 5 limitieren, und mindestens
// 1 Datei als Rückgabe erwarten
$upload->addValidator('Count', array(1, 5);

            

Hinweis: Beachte das diese Prüfung die Anzahl der geprüften Dateien intern speichert. Die Datei welche das Maximum überschrietet wird als Fehler zurückgegeben.

Die Exists Prüfung checkt ob Dateien die angegeben werden existieren. Sie unterstützt die folgenden Optionen:

• directory: Checkt ob die Datei im gegebenen Verzeichnis existiert.

Diese Prüfung akzeptiert mehrere Verzeichnisse, entweder als Komma-getrennter String, oder als Array. Es können aber auch die Methoden setDirectory(), addDirectory(), und getDirectory() verwendet werden um die Verzeichnisse zu setzen und zu erhalten.

$upload = new Zend_File_Transfer();

// Das temporäre Verzeichnis für die Prüfung hinzufügen
$upload->addValidator('Exists', '\temp');

// Zwei Verzeichnisse hinzufügen inden die Array Schreibweise verwendet wird
$upload->addValidator('Exists', array('\home\images', '\home\uploads'));

            

Hinweis: Beachte das diese Prüfung checkt ob die Datei in allen gesetzten Verzeichnissen existiert. Die Prüfung schlägt fehl, wenn die Datei in irgendeinem der angegebenen Verzeichnisse nicht existiert.

Die Extension Prüfung checkt die Dateierweiterung der Dateien welche angegeben werden. Sie unterstützt die folgenden Optionen:

• extension: Prüft ob die angegebene Datei diese Dateierweiterung verwendet.

• case: Definiert of die Prüfung auf die Klein/Großschreibung achten soll. Standardmäßig ist die Klein/Großschreibung egal. Es ist zu beachten das diese Option für alle verwendeten Erweiterungen verwendet wird.

Dieser Prüfer akzeptiert mehrere Erweiterungen entweder als komma-getrennten String, oder als ein Array. Man kann auch die setExtension(), addExtension() und getExtension() Methoden verwenden um Erweiterungen zu setzen und zu erhalten.

In einigen Fällen ist es nützlich auch auf Klein/Großschreibung zu testen. Hierfür erlaubt der Constructor einen zweiten Parameter $case der, wenn er auf true gesetzt wird, die Erweiterungen abhängig von der Klein/Großschreibung prüft.

$upload = new Zend_File_Transfer();

// Limitiert die Erweiterungen auf jpg und png Dateien
$upload->addValidator('Extension', 'jpg,png');

// Limitiert die Erweiterungen auf jpg und png Dateien, verwendet aber die Array Schreibweise
$upload->addValidator('Extension', array('jpg', 'png'));

// Abhängig von der Klein/Großschreibung prüfen
$upload = new Zend_File_Transfer('mo,png', true);
if (!$upload->isValid('C:\temp\myfile.MO')) {
    print 'Nicht gültig da MO statt mo verwendet wurde';
}

            

Hinweis: Es ist zu beachten das diese Prüfung nur die Dateierweiterung prüft. Sie prüft nicht den MIME Typ der aktuellen Datei.

Die FilesSize Prüfung checkt die komplette Größe aller übertragenen Dateien. Sie unterstützt die folgenden Optionen:

• min: Setzt die minimale gemeinsame Dateigröße.

  Mit dieser Option kann die mindeste gemeinsame Dateigröße der Dateien definiert werden die man empfangen will.

• max: Setzt die maximale gemeinsame Dateigröße.

  Mit dieser Option kann die gemeinsame Dateigröße aller Dateien die übertragen wurden, limitiert werden, aber nicht die Dateigröße von einzelnen Dateien.

Diese Prüfung kann mit beiden Optionen initiiert werden. Die erste Option ist min, die zweite Option max. Wenn nur eine Option angegeben wird, wird diese als max verwendet. Aber man kann auch die Methoden setMin() und setMax() verwenden um beide Optionen im Nachhinein zu setzen und getMin() sowie getMax() um die aktuell gesetzten Werte zu erhalten.

Die Größe selbst wird auch in der SI Schreibweise akzeptiert wie Sie von den meisten Betriebsystemen angegeben wird. Statt 20000 Bytes kann man auch 20kB angeben. Alle Einheiten werden mit dem Basiswert 1024 konvertiert. Die folgenden Einheiten werden akzeptiert: kB, MB, GB, TB, PB und EB. Wie erwähnt muss man berücksichtigen das 1kB gleich 1024 Bytes entspricht.

$upload = new Zend_File_Transfer();

// Limitiert die Größe aller angegebenen Dateien auf 40000 Bytes
$upload->addValidator('FilesSize', 40000);

// Limitiert die Größe aller angegebenen Dateien auf maximal 4MB und minimal 10kB
$upload->setValidator('FilesSize', array('10kB', '4MB');

            

Hinweis: Es ist zu beachten das diese Prüfung die Dateigrößen der geprüften Dateien intern speichert. Die Datei welche die Größe überschreitet wird als Fehler zurückgegeben.

Die ImageSize Prüfung checkt die Größe von Bildern. Sie unterstützt die folgenden Optionen:

• minheight: Setzt die mindeste Höhe des Bildes.

  Mit dieser Option kann die Mindesthöhe des Bildes definiert werden das geprüft werden soll.

• maxheight: Settzt die maximale Höhe des Bildes.

  Mit dieser Option kann di Maximalhöhe des Bildes limitiert werden das geprüft werden soll.

• minwidth: Setzt die mindeste Breite des Bildes.

  Mit dieser Option kann die mindeste Breite des Bildes definiert werden das geprüft werden soll.

• maxwidth: Setzt die maximale Breite des Bildes.

  Mit dieser Option kann die maximale Breite des Bildes limitiert werden das geprüft werden soll.

Diese Prüfung kann mit allen vier gesetzten Optionen initiiert werden. Wenn minheight oder minwidth nicht angegeben werden, werden Sie auf 0 gesetzt. Und wenn maxwidth oder maxheight nicht angegeben werden, werden Sie auf null gesetzt. Aber man kann auch die setImageMin() und setImageMax() Methoden verwenden um beide Minimal- und Maximalwerte im Nachhinein zu setzen und getMin() und getMax() um die aktuell gesetzten Werte zu erhalten.

Der Bequemlichkeit halber gibt es auch die setImageWidth und setImageHeight Methoden welche die Mindest- und Maximalhöhe und -Breite setzen können. Natürlich sind auch passende getImageWidth und getImageHeight Methoden vorhanden.

Um die Prüfung einer Dimension zu unterdrücken muß der betreffende Wert einfach auf null gesetzt werden.

$upload = new Zend_File_Transfer();

// Begrenzt die Größe eines Bildes auf eine Höhe von 100-200
// und eine Breite von 40-80 Pixel
$upload->addValidator('ImageSize', 40, 100, 80, 200);

// Verwendet die Array Schreibweise
$upload->setValidator('ImageSize', array(40, 100, 80, 200);

// Verwendet die benannte Array Schreibweise
$upload->setValidator('ImageSize',
                      array('minwidth' => 40,
                            'maxwidth' => 80,
                            'minheight' => 100,
                            'maxheight' => 200
                     );

// Setzt andere Dimensionen für das Bild
$upload->setImageWidth(20, 200);

            

Die MimeType Prüfung checkt den Mimetyp von übertragenen Dateien. Sie unterstützt die folgenden Optionen:

• MimeType: Setzt die Art des Mimetyps der geprüft werden soll.

  Mit dieser Option kann der Mimetyp von Dateien definiert werden der akzeptiert werden soll.

Diese Prüfung akzeptiert viele Mimetypen entweder als Komma-getrennter String, oder als Array. Man kan auch die Methoden setMimeType(), addMimeType(), und getMimeType() verwenden um Mimetypen zu setzen und zu erhalten.

$upload = new Zend_File_Transfer();

// Begrenzt den Mimetyp aller gegebenen Dateien auf Gif Bilder
$upload->addValidator('MimeType', 'image/gif');

// Begrenzt den Mimetyp alle gegebenen Dateien auf Gif und Jpeg Dateien
$upload->setValidator('MimeType', array('image/gif', 'image/jpeg');

// Begrenzt den Mimetyp aller Dateien auf die Gruppe image
$upload->setValidator('MimeType', 'image');

            

Das obige Beispiel zeigt das es auch möglich ist den akzeptierten Mimetyp auf eine Gruppe von Mimetypen zu begrenzen. Um alle Bilder zu erlauben kann einfach 'image' als Mimetyp verwendet werden. Das kann für alle Gruppen wie 'image', 'audio', 'video', 'test', und so weiter gemacht werden.

Hinweis: Es ist zu beachten das die Verwendung von Mimetyp-Gruppen alle Mitglieder dieser Gruppe akzeptiert, selbst wenn die Anwendung diese nicht unterstützt. Wenn man 'image' erlaubt, erhält man auch 'image/xpixmap' oder 'image/vasa' was problematisch sein könnte. Wenn man nicht sicher ist ob die eigene Anwendung alle Typen unterstützt ist es besser nur definierte Mimetypen zu erlauben statt der kompletten Gruppe.

Die NotExists Prüfung checkt ob Dateien die angegeben werden existieren. Sie unterstützt die folgenden Optionen:

• directory: Checkt ob die Datei im gegebenen Verzeichnis nicht existiert.

Diese Prüfung akzeptiert mehrere Verzeichnisse, entweder als Komma-getrennter String, oder als Array. Es können aber auch die Methoden setDirectory(), addDirectory(), und getDirectory() verwendet werden um die Verzeichnisse zu setzen und zu erhalten.

$upload = new Zend_File_Transfer();

// Das temporäre Verzeichnis für die Prüfung hinzufügen
$upload->addValidator('NotExists', '\temp');

// Zwei Verzeichnisse durch Verwendung der Array Schreibweise hinzufügen
$upload->addValidator('NotExists',
                      array('\home\images',
                            '\home\uploads')
                     );

            

Hinweis: Beachte das diese Prüfung checkt ob die Datei in allen gesetzten Verzeichnissen nicht existiert. Die Prüfung schlägt fehl, wenn die Datei in irgendeinem der angegebenen Verzeichnisse existiert.

Die Size Prüfung checkt die Größe von einzelnen Dateien. Sie unterstützt die folgenden Optionen:

• Min: Setzt die mindimale Dateigröße.

  Mit dieser Option kann die mindeste Dateigröße für einzelne Dateien die übertragen werden definieren.

• Max: Setzt die maximale Dateigröße.

  Mit dieser Option kann die Dateigröße für einzelne Dateien die übertragen werden limitieren.

Diese Prüfung kann mit beiden Optionen initiiert werden. Die erste Option ist min, die zweite Option max. Wenn nur eine Option angegeben wird, wird diese als max verwendet. Aber man kann auch die Methoden setMin() und setMax() verwenden um beide Optionen im Nachhinein zu setzen, sowie getMin() und getMax() um die aktuell gesetzten Werte zu erhalten.

Die Größe selbst wird auch in der SI Schreibweise akzeptiert wie Sie von den meisten Betriebsystemen angegeben wird. Statt 20000 Bytes kann man auch 20kB angeben. Alle Einheiten werden mit dem Basiswert 1024 konvertiert. Die folgenden Einheiten werden akzeptiert: kB, MB, GB, TB, PB und EB. Wie erwähnt muss man berücksichtigen das 1kB gleich 1024 Bytes entspricht.

$upload = new Zend_File_Transfer();

// Limitiert die Größe einer Datei auf 40000 Bytes
$upload->addValidator('Size', 40000);

// Limitiert die Größe der angegebenen Datei auf maximal 4MB und
// minimal 10kB, und limitiert diese Prüfung auf die Datei 'uploadfile'
$upload->addValidator('Size', array('10kB', '4MB', 'uploadfile');