L'utilisation des validateurs est assez simple. Il existe de multiples méthodes pour ajouter et manipuler les validateurs.

• addValidator($validator, $options = null, $files = null) : ajoute le validateur à la pile des validateurs (optionnellement seul le(s) fichier(s) spécifié(s)). $validator peut être soit une instance d'un validateur réel, ou un nom court spécifiant le validateur (par exemple, "Count").

• addValidators(array $validators, $files = null) : ajoute les validateurs à la pile des validateurs. Chaque entrée peut être soit une paire type/options, ou un tableau avec la clé "validator" spécifiant le validateur (tous les autres options seront considérées comme des options du validateur au moment de l'instanciation).

• setValidators(array $validators, $files = null) : surcharge les validateurs existants avec les validateurs spécifiés. Les validateurs doivent respecter la même syntaxe que addValidators().

• hasValidator($name) : indique si un validateur est enregistré.

• getValidator($name) : retourne un validateur préalablement enregistré.

• getValidators($files = null) : retourne les validateurs enregistrés ; si $files est fourni, retourne les validateurs pour ce fichier en particulier ou pour tous les fichiers.

• removeValidator($name) : enlève le validateur préalablement enregistré.

• clearValidators() : efface tous les validateurs.

$upload = new Zend_File_Transfer();

// Paramètre un poids de fichier de 20000 octets
$upload->addValidator('Size', 20000);

// Paramètre un poids de fichier de 20 octets minimum et de 20000 octets maximum
$upload->addValidator('Size', array(20, 20000));

// Paramètre un poids de fichier de 20 octets minimum et de 20000 octets maximum et un nombre de fichiers en une seule téape
$upload->setValidators(array(
    'Size'  => array(20, 20000), 
    'Count' => array(1, 3),
));

$upload = new Zend_File_Transfer();

// Paramètre un poids de fichier de 20000 octets et limite celui-ci à 'file2'
$upload->addValidator('Size', 20000, 'file2');

Généralement vous devriez simplement utiliser la méthode addValidators(), qui peut être appelée plusieurs fois.

$upload = new Zend_File_Transfer();

// Paramètre un poids de fichier de 20000 octets
$upload->addValidator('Size', 20000)
       ->addValidator('Count', 2)
       ->addValidator('Filessize', 25000);

Note: Notez que même si l'ajout du même validateur plusieurs fois est autorisé, faire ceci peut entraîner des problèmes si vous utilisez différentes options pour le même validateur.

Le validateur Count vérifie le nombre de fichiers fournis. Il supporte les options suivantes :

• min : paramètre le nombre minimum de fichiers à transférer.

  Note: Attention : quand vous utilisez cette option vous devez donner le nombre minimum au moment où vous appelez ce validateur la première fois ; sinon vous aurez une erreur en retour.
  

  Avec cette option vous pouvez définir le nombre de fichiers que vous souhaitez recevoir.

• max : paramètre le nombre maximum de fichiers à transférer.

  Avec cette option vous pouvez limiter le nombre de fichiers que vous acceptez mais vous permet aussi de détecter une possible attaque quand plus de fichiers, que votre formulaire n'en définit, sont fournis.

Vous pouvez initialiser ce validateur avec ces deux options. La première option est min, la seconde est max. Quand seule une option est fournie, elle est utilisée en tant que max. Mais vous pouvez aussi utiliser les méthodes setMin() et setMax() pour paramétrer ces options plus tard et getMin() et getMax() pour les récupérer.

$upload = new Zend_File_Transfer();

// Limite le nombre de fichiers à 2 maximum
$upload->addValidator('Count', 2);

// Limite le nombre de fichiers à 5 maximum, tout en obligeant au moins 1 fichier
$upload->addValidator('Count', array(1, 5);

Note: Notez que ce validateur stocke le nombre de fichiers vérifiés en interne. Le fichier qui excédera le maximum sera retourné en tant qu'erreur.

Le validateur Exists l'existence des fichiers fournis. Il supporte les options suivantes :

• directory : vérifie si le fichier existe dans le dossier fourni.

Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau. Vous pouvez aussi utiliser les méthodes setDirectory(), addDirectory(), et getDirectory() pour paramétrer et récupérer les extensions.

$upload = new Zend_File_Transfer();

// Add the temp directory to check for
$upload->addValidator('Exists', '\temp');

// Add two directories using the array notation
$upload->addValidator('Exists', array('\home\images', '\home\uploads'));

Note: Notez que ce validateur vérifie si le fichier existe dans tous les dossiers fournis. La validation échoue si le fichier est manquant dans l'un des dossiers.

Le validateur Extension vérifie l'=es extensions des fichiers qui ont été fournis. Il supporte les options suivantes :

• extension : paramètre l'extension à vérifier.

• case : paramètre une validation sensible à la casse. Par défaut, la validation n'est pas sensible à la casse. Notez que cette option est utilisée pour toutes les extensions.

Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau. Vous pouvez aussi utiliser les méthodes setExtension(), addExtension(), et getExtension() pour paramétrer et récupérer les extensions.

Dans certains cas, il est utile vérifier aussi la casse. A cette fin le constructeur autorise un second paramètre $case qui, s'il est réglé à true, validera l'extension en vérifiant aussi la casse.

$upload = new Zend_File_Transfer();

// Limite les extensions à jpg et png
$upload->addValidator('Extension', 'jpg,png');

// Limite les extensions à jpg et png en utilisant la notation de type tableau
$upload->addValidator('Extension', array('jpg', 'png'));

// Check case sensitive
$upload = new Zend_File_Transfer('mo,png', true);
if (!$upload->isValid('C:\temp\myfile.MO')) {
    print 'Not valid due to MO instead of mo';
}

Note: Notez que ce validateur ne vérifie que l'extension de fichier. Il ne vérifie pas le type MIME réel du fichier.

Le validateur FilesSize vérifie le poids total de tous les fichiers transférés. Il supporte les options suivantes :

• min : paramètre le poids minimum de tous les fichiers.

  Avec cette option vous pouvez définir le poids minimum de tous les fichiers que vous souhaitez transférer.

• max : paramètre le poids maximum de tous les fichiers.

  Avec cette option vous pouvez limiter le poids total des fichiers qui doivent être transférés, mais pas la taille individuelle de chaque fichier.

Vous pouvez initialiser ce validateur avec ces deux options. La première option est min, la seconde est max. Quand seule une option est fournie, elle est utilisée en tant que max. Mais vous pouvez aussi utiliser les méthodes setMin() et setMax() pour paramétrer ces options plus tard et getMin() et getMax() pour les récupérer.

La taille elle-même est acceptée en notation SI comme sur la plupart des systèmes d'exploitation. Au lieu de 20000 octets (NdT. : "bytes" en anglais), vous pouvez utiliser 20kB. Toutes les unités sont converties en utilisant 1024 comme valeur de base. Les unités suivantes sont acceptées : kB, MB, GB, TB, PB et EB. Comme mentionné précédemment vous devez noter que 1kB équivaut à 1024 octets.

$upload = new Zend_File_Transfer();

// Limite la taille de tous les fichiers à 40000 octets
$upload->addValidator('FilesSize', 40000);

// Limite la taille de tous les fichiers dans une plage de 10kB à 4MB
$upload->setValidator('FilesSize', array('10kB', '4MB');

Note: Notez que ce validateur stocke le poids des fichiers vérifiés en interne. Le fichier qui excédera le poids maximum sera retourné en tant qu'erreur.

Le validateur ImageSize vérifie la taille des images. Il supporte les options suivantes :

• minheight : paramètre la hauteur minimum d'une image.

  Avec cette option vous pouvez définir la hauteur minimum pour qu'une image soit validée.

• maxheight : paramètre la hauteur maximum d'une image.

  Avec cette option vous pouvez limiter la hauteur maximum pour qu'une image soit validée.

• minwidth : paramètre la largeur minimum d'une image.

  Avec cette option vous pouvez définir la largeur minimum pour qu'une image soit validée.

• maxwidth : paramètre la largeur maximum d'une image.

  Avec cette option vous pouvez limiter la largeur maximum pour qu'une image soit validée.

Vous pouvez initialiser ce validateur avec ces quatre options. Quand minheight ou minwidth sont omises, elles sont réglées à 0. Et quand maxwidth ou maxheight ne sont pas fournies, elles sont réglées à null. Mais vous pouvez aussi utiliser les méthodes setImageMin() et setImageMax() pour régler les valeurs minimum et maximum plus tard et getMin() et getMax() pour les récupérer.

Par commodité, il existe aussi les méthodes setImageWidth et setImageHeight qui paramètrent la largeur et la hauteur minimum et maximum. Bien sûr les méthodes associées getImageWidth et getImageHeight sont aussi disponibles.

Pour désactiver la validation d'une dimension, paramétrez la valeur correspondante à null.

$upload = new Zend_File_Transfer();

// Limite la taille de l'image à une hauteur de 100 à 200 et une largeur de 40 à 80 pixels
$upload->addValidator('ImageSize', 40, 100, 80, 200);

// Utilise la notation de type tableau
$upload->setValidator('ImageSize', array(40, 100, 80, 200);

// Utilise la notation de type tableau indexé
$upload->setValidator('ImageSize', array('minwidth' => 40, 'maxwidth' => 80, 'minheight' => 100, 'maxheight' => 200);

// Autre possibilité de réglage
$upload->setImageWidth(20, 200);

Le validateur MimeType vérifie le type MIME des fichiers transférés. Il supporte les options suivantes :

• MimeType: paramètre le type MIME à contrôler.

  Avec cette option vous pouvez définir le type MIME des fichiers qui seront acceptés.

Ce validateur accepte des types MIME multiples soit sous la forme d'une chaîne utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau. Vous pouvez aussi utiliser les méthodes setMimeType(), addMimeType(), et getMimeType() pour paramétrer et récupérer les types MIME.

$upload = new Zend_File_Transfer();

// Limite le type MIME de tous les fichiers aux images gif
$upload->addValidator('MimeType', 'image/gif');

// Limite le type MIME de tous les fichiers aux images jpeg et gif
$upload->setValidator('MimeType', array('image/gif', 'image/jpeg');

// Limite le type MIME de tous les fichiers au groupe des images
$upload->setValidator('MimeType', 'image');

L'exemple ci-dessus montre qu'il est aussi possible de limiter le type MIME accepté à un groupe de type MIME. Pour autoriser toutes les images utilisez simplement "image" en tant que type MIME. Ceci peut être appliqué à tous les groupes de type MIME comme "image", "audio", "video", "text" et plus encore.

Note: Notez qu'autoriser un groupe de type MIME acceptera tous les membres e ce groupe même si votre application ne les supporte pas. Par exemple quand vous autorisez "image", vous autorisez donc "image/xpixmap" ou "image/vasa", ce qui peut être problématique. Quand vous n'êtes pas sûr que votre application supporte tous les types, vous devriez définir individuellement les types MIME plutôt que le groupe complet.

Le validateur NotExists l'existence des fichiers fournis. Il supporte les options suivantes :

• directory : vérifie si le fichier n'existe pas dans le dossier fourni.

Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau. Vous pouvez aussi utiliser les méthodes setDirectory(), addDirectory(), et getDirectory() pour paramétrer et récupérer les extensions.

$upload = new Zend_File_Transfer();

// Add the temp directory to check for
$upload->addValidator('NotExists', '\temp');

// Add two directories using the array notation
$upload->addValidator('NotExists', array('\home\images', '\home\uploads'));

Note: Notez que ce validateur vérifie si le fichier n'existe dans aucun des dossiers fournis. La validation échoue si le fichier existe dans l'un des dossiers.

Le validateur Size vérifie le poids d'un fichier unique. Il supporte les options suivantes :

• Min: paramètre le poids minimum du fichier.

  Avec cette option vous pouvez définir le poids minimum d'un fichier que vous souhaitez transférer.

• Max: paramètre le poids maximum du fichier.

  Avec cette option vous pouvez limiter le poids d'un fichier que vous souhaitez transférer.

Vous pouvez initialiser ce validateur avec ces deux options. La première option est min, la seconde est max. Quand seule une option est fournie, elle est utilisée en tant que max. Mais vous pouvez aussi utiliser les méthodes setMin() et setMax() pour paramétrer ces options plus tard et getMin() et getMax() pour les récupérer.

La taille elle-même est acceptée en notation SI comme sur la plupart des systèmes d'exploitation. Au lieu de 20000 octets, vous pouvez utiliser 20kB. Toutes les unités sont converties en utilisant 1024 comme valeur de base. Les unités suivantes sont acceptées : kB, MB, GB, TB, PB et EB. Comme mentionné précédemment vous devez noter que 1kB équivaut à 1024 octets.

$upload = new Zend_File_Transfer();

// Limit the size of a file to 40000 bytes
$upload->addValidator('Size', 40000);

// Limit the size a given file to maximum 4MB and mimimum 10kB and limits this
// validator to the file "uploadfile"
$upload->addValidator('Size', array('10kB', '4MB', 'uploadfile');